Skip to content

Python Environment Setup

Scripting support requires the supported version of Python to be installed on the machine where the Tool is installed. When users install the Tool, Python is not part of the installation. Users must explicitly install Python if scripting support is needed.

Installing Python

The Tool package comes with Python installation package. It can be found under the 3rdParty folder as shown below.

Python Environment Setup – figure 1

Installation of Python is quite straightforward: simply running the installation package by double-clicking file and following the instructions. However, it is very important to choose the right Python installation package.

Installation steps:

  1. Remove the previous version of Python if installed.
  2. Install the supported Python, making sure checkbox “Add python.exe to Path” is checked. Python Environment Setup – figure 2
  3. Start a Command line console. Execute Python in the command line to verify that the proper version of Python is installed. Python Environment Setup – figure 3

If Python is installed successfully, but the Python command is not recognized, you may close the current Command line session and stat a new one or reboot machine after installing Python to make the environment variables updated. Please also check the Python path is in the PATH environment variable.

Python Environment Setup – figure 4

Testing Installation

Once Python is installed, users should test the installation. If Python installation is successfully tested, run a Python script from the UI as shown below

  1. Right-mouse-click the blank spot in the tree panel to invoke the Global Context Menu. Select ‘Run Python→ via Config’, or click the corresponding Command Icon form the toolbar in the Control Panel, as illustrated below. Python Environment Setup – figure 5 Python Environment Setup – figure 6
  2. Select Hello World from the dropdown list in the popup dialog. Python Environment Setup – figure 7
  3. If execution of the script is successful, user shall get the messages sent from the executed script as shown below, Python Environment Setup – figure 8

and a test model should be loaded into the Tool

Python Environment Setup – figure 9

Supporting Other Versions of Python

The Python language does not provide backward compatibility. Only one version of Python can be supported by the Tool. However, workarounds/patching solutions are available, depending on the versions of Python to be supported. The Options include:

  1. When upgrading/downgrading the supported Python x.y.z1 to a later/earlier patch version, i.e. Python x.y.z2, there should be no impact on the installed Tool. This is based on the previous experience.
  2. When upgrading/downgrading to a different minor/major Python version, the following workaround may work.
    1. Rename pythonXY.dll under folder bin, such as pythonXY_original.dll.
    2. Copy the corresponding python dll of the installed version of Python from the python folder (for example C:\Users\user1\AppData\Local\Programs\Python\PythonXZ) to the bin folder.
    3. Rename the copied pythonXZ.dll to pythonXY.dll.
    4. Test the patched solution.
  3. If option B) doesn’t work, contact us for a patching package.

Trouble Shooting

If you get the following message when running Python test script, it means your Python environment is not ready. The message lists possible reasons and the suggestion to resolve the issue.

Python Environment Setup – figure 10

Need help? Contact cimspy_help@power-gem.com