CYME

Power Engineering Software and Solutions

CYME Scripting Tool with Python®

Extending CYME capabilities through

Python® Scripting
Today’s fast evolving Aiming to ease the effort • The Console allows the With Python scripting, users can
required in performing several users to carry out commands easily perform batch analysis,
power systems require simulations by hand and to directly in the CYME automate routine studies,
engineers to perform extend the customization of the application to allow command create new algorithms, and
thorough studies for the CYME applications, Python® testing, variable value quickly retrieve information and
scripting has been integrated inspection and quickly retrieve create charts quickly retrieve
purpose of evaluating the into the CYME power system information. A command information through a simple
operation of their networks analysis software. manager keeps track of the mouse-click on a script. Take
history of commands. advantage of all the possibilities
under different conditions. Python scripting comes with
offered by the CYME Scripting
Although informative, some a Site Package, a Console, a • The Toolbox allows the users
Tool and appreciate the increase
Toolbox and a built-in script to add and execute scripts.
of these studies could editor. It can be used in a stand- Variables defined in the scripts
in productivity brought by the
creativity of your scripts.
be repetitive and time- alone mode or in a mode directly can be accessed through the
consuming. Automation embedded into the CYME Toolbox without having the
software. scripts being modified.
relieves engineers from any
• The Python Site Package • The built-in script editor that
redundant and laborious contains all the modules is simple to use and includes
procedures, and provides and functions required to features such as syntax
them the information access network properties, highlighting, color-coding and
manipulate equipment code-completion.
and results required in an and devices, perform
effortless manner. various analyses and more
importantly, obtain meaningful
results.
CYME Scripting Easy Scripting with Python®
Python is a scripting language
Python® suits your needs and
style
Besides quickly retrieving
information through several
command lines or to run routine
that is open-source and The Python Console and
Tool with cross-platform. Toolbox allow an embedded
Python usage within the CYME
analysis through the use of
scripts, the users can also
Unlike other programming create their own algorithms and
software for the rapid execution
Python® languages, Python does not
have difficult syntax and offers
of several command and scripts.
write their own analysis. For
example, you can create your
code completion. Its high The user can write scripts own Load Growth analysis to
readability combined with using the built-in script editor, modify the loads in a complex
the CYME function names and can as well write scripts way that cannot be easily
Extending CYME capabilities make Python easy to learn in any text editor and execute achieved with the default Load
through Python® Scripting for beginners while staying them in a “stand-alone” way Growth analysis. Likewise, your
powerful for experts. outside of the CYME application commands can be inserted
environment, via your favorite to apply modifications to the
Not only does it take care of network. Charts and reports are
Python IDE (IDLE, Komodo IDE,
exception handling, the CYME easily customizable to display
Eclipse, PythonWin, PyCharm,
Scripting Tool with Python has the results according to your
etc.).
also been robustly designed to preferences.
provide you with the latest data Extending CYME
model so that you can always be Several device controls and
up to date. Whether scripts and commands customization tools now
are run in the embedded offer embedded scripting
Python scripting takes advantage or non-embedded way, the functionalities. Scripts can now
of all the power accessible possibilities to extend the be used to define the control for
through regular expressions, capabilities of the CYME capacitors, regulators, battery
along with an advanced filtering software are unlimited. energy storage systems and
mode that comes to hand when centralized capacitor control
accessing data collection. The Site Package developed
systems. They can also be used
offers many modules designed
to create custom keywords and
to be powerful and easy-to-use:
filters.
network modeling, database
access, equipment, report Python’s power and user-
and error management. These friendliness make it the ideal
modules are constantly evolving tool for writing any large
to better suit the growth of the application to suit your needs
application. and simplify your work.
Combined with your creativity,
Python scripting can extend
the already-robust capabilities
of the CYME software beyond
imagination.

Eaton
1000 Eaton Boulevard
Cleveland, OH 44122
United States
Eaton.com

CYME International T&D

1485 Roberval, Suite 104
St.Bruno, QC, Canada J3V 3P8
P: 450.461.3655 F: 450.461.0966
P: 800.361.3627 (Canada/USA)
CymeInfo@eaton.com
www.eaton.com/cyme
Follow us on social media to get the
© 2018 Eaton All Rights Reserved Eaton is a registered trademark. latest product and support information.
Printed in Canada
Publication No. BR 917 040 EN All other trademarks are property
February 2018 of their respective owners.