Getting started

In order to start and run the eGo-tool a few steps needs to be done.

Steps to run eGo

  1. Are you registered on the OpenEnergy Platform? The registration for the public accessible API can be found on
  2. You have Python 3 installed? Install for example the Python distribution of
  3. Install and use a virtual environment for your installation (optional).
  4. Install the eGo tool pip3 install eGo --process-dependency-links.
  5. Create mid and low voltage distribution grids with ding0. Learn more about Ding0 on
  6. Check and prepare your eGo setting in ego/scenario_setting.json. Add your local paths and prepare your parameters.
  7. Start your calculation and run the tool for example under eGo/ego and >>> python3 . You can also use any other Python Terminal, Jupyter Notebook or Editor.

How to use eGo?

Start and use eGo from the terminal.

>>> python3
>>> ...
>>> INFO:ego:Start calculation
>>> ...


Inside the

# import the eGo tool
from import eGo

# Run your scenario
ego = eGo(jsonpath='scenario_setting.json')

# Analyse your results on extra high voltage level (etrago)

eGo Result Example of Germany

A small example of the eGo results is displayed below. The full page can be found here

The plot is created by the eGo function: