eracs/python-interface repository overview

⁠ERACS Python Interface - Docker

The ERACS Python Interface docker images are intended to be used as base images for (web) applications that wish to harness the capability of the ERACS Python Interface. However, you can also pull any of these images directly and use them to execute the example scripts or custom written scripts.

For more information on the ERACS Python Interface and its capabilities, please read the documentation⁠.

⁠Execution

docker run eracs/python-interface:VERSION [COMMAND]

Below is an example of running the latest image to perform a Loadflow study using the LFExampleNoGUI.py example script, provided with the ERACS Python Interface...

docker run eracs/python-interface:latest "C:/Program Files (x86)/ERACS/Python/Examples/Loadflow/LFExampleNoGUI.py"

The COMMAND is optional, if no script path is given then the image will enter into a long-running Python process (process ID 1). If you were to do this in detached mode, you can use docker exec to execute a new process such as Powershell and perform various operations whilst the container remains running.

⁠Versions

Each version of the ERACS Python Interface is available via its appropriately tagged dedicated image. Users may wish to remain on the latest version of the ERACS Python Interface without needing to explicitly upgrade, so, to fulfil that requirement we provide a latest tagged image. However, we do not recommend using latest, because breaking changes may cause unexpected behaviour to occur. Earlier versions of the ERACS Python Interface (< 1.3.0) are missing because they predate ERACS' support of Docker.

⁠Useful paths

The ERACS Python Interface images are built upon a Microsoft Windows Server Core base image. The following are useful paths which may be worth remembering...

• C:/Python/Eracs/ - Location of the ERACS Python Interface.
• C:/Program Files (x86)/ERACS/ - Location of the basic ERACS installation, only the DLLs (dynamic link libraries) are provided.
• C:/Program Files (x86)/ERACS/Python/ - Location of the requirements.txt file for the ERACS Python Interface.
• C:/Program Files (x86)/ERACS/Python/Examples/ - Location of the ERACS Python Interface example scripts.
• C:/Users/Eracs/Documents/ERACS Projects/Python Scripts/ - The working directory, user scripts should be placed here.

⁠Tools

The following tools are installed into every ERACS Python Interface docker image.

• Windows kernel
• Powershell
• Python 3.9 (32-bit) with ERACS Python Interface dependencies installed via pip
• Chocolatey Windows package manager

⁠User

The default user inside the ERACS Python Interface image is Eracs. This user account has administrative rights and can be used to perform any necessary operations.