Select your location

CYME scripting tool with Python

Today’s fast evolving power systems require engineers to perform thorough studies for the purpose of evaluating the operation of their networks under different conditions. Although informative, some of these studies can be repetitive and time-consuming. Automation relieves engineers from redundant and laborious procedures, and effortlessly provides the required information and results.
Aiming to ease the effort required in performing several simulations by hand and to extend the customization of Eaton's CYME software applications, Python scripting has been integrated into the CYME power system analysis software. With Python scripting, users can easily perform batch analysis, automate routine studies, create new algorithms, and quickly retrieve information through a simple mouse-click on a script.



Python scripting comes with a Site Package, a Console, a Toolbox and a built-in script editor. It can be used in a stand-alone mode or in a mode directly embedded into Eaton's CYME software.

  • The Python Site Package contains all the modules and functions required to access network properties, manipulate equipment and devices, perform various analyses and more importantly, obtain meaningful results
  • The Console allows users to carry out commands directly in the CYME application to allow command testing, variable value inspection and quickly retrieve information. A command manager keeps track of the history of commands
  • The Toolbox allows the users to add and execute scripts. Variables defined in the scripts can be accessed through the Toolbox without having the scripts be modified
  • The built-in script editor is simple to use and includes features such as syntax highlighting, color-coding and code-completion

Python is a scripting language that is open-source and cross-platform.

Unlike other programming languages, Python does not have difficult syntax and offers code completion.  Its high readability combined with Eaton's CYME function names makes Python easy to learn for beginners while staying powerful for experts.

Not only does it take care of exception handling, the CYME Scripting Tool with Python has also been robustly designed to provide the latest data model.

Python scripting takes advantage of all the power accessible through regular expressions, along with an advanced filtering mode that helps when accessing data collection.


The Python Console and Toolbox allow embedded Python usage within Eaton's CYME software for the rapid execution of several command and scripts.

Users can write scripts using the built-in script editor, and also write scripts in any text editor and execute them in a “stand-alone” process outside of the Eaton's CYME application environment, via your favorite Python IDE (IDLE, Komodo IDE, Eclipse, PythonWin, PyCharm, etc.).


Whether scripts and commands are run in the embedded or non-embedded way, the possibilities to extend the capabilities of Eaton's CYME software are unlimited.

The Site Package developed offers many modules designed to be powerful and easy-to-use: network modeling, database access, equipment, report and error management. These modules are constantly evolving to better suit the growth of the application.

Besides quickly retrieving information through several command lines or running routine analysis through the use of scripts, users can also create their own algorithms and write their own analysis. For example, users can create their own Load Growth analysis to modify the loads in a complex way that cannot be easily achieved with the default Load Growth analysis. Likewise, your commands can be inserted to apply modifications to the network. Charts and reports are easily customizable to display the results according to your preferences.

Several device controls and customization tools now offer embedded scripting functionalities. Scripts can now be used to define the control for capacitors, regulators, battery energy storage systems and centralized capacitor control systems. They can also be used to create custom keywords and filters.

Python’s power and user-friendliness makes it the ideal tool for writing any large application to suit your needs and simplify your work.

Need product support?

CYME users portal:

P: 450-461-3655 or 800-361-3627 (Canada & US)


Questions before you buy