Installation

Windows

1. Install Python (3.8 or 3.9) Windows users can finde the versions here: Python download page for windows

Note

Make sure to use the installer referring to your windows version (e.g. “Windows x86-64 executable installer” for windows 64-bit version). You can check the build in bit version following these steps.

Note

The SESMG is not compatible with the python version 3.9.7, due to a confliciting bug in this version to the subpackage streamlit. You need do install another pyhton version or update to another python version e. g. 3.9.13, which is widely tested.

_images/sesmg_installation_ms_1.png

Note

Make sure to select “Add pyton to PATH” at the beginning of the Python installation.

_images/sesmg_installation_ms_2.png

  1. Download the Spreadsheet Energy System Model Generator from GitHub as .zip folder and extract the .zip folder into any directory on the computer.

_images/sesmg_installation_ms_3.png

  1. Download Graphiz here: Graphiz download

_images/sesmg_installation_ms_4.png

Note

Make sure to select “Add Graphiz to system path for all users” at the beginning of the installation, otherwise you can use the default settings.

_images/sesmg_installation_ms_5.png

  1. Download cbc solver here: cbc solver for windows. Alternatively you can uses the direct download link

_images/sesmg_installation_ms_6.png

Note

Extract the .zip file and copy the cbc solver (go to the bin-folder and use the cbc.exe) into the SESMG directory.

_images/sesmg_installation_ms_7.png

The gurobi solver may be used as alternative to the cbc-solver. Be aware, that the gurobi-solver is not open-source and a license is required. However, the gurobi may be faster for certain types of optimization problems, especially for those containing binary decisions. The installation procedure of the gurobi solver is described in detail here: https://www.gurobi.com/documentation/quickstart.html

  1. Execute the windows_installation.cmd and add your python version (this may take several minutes).

_images/sesmg_installation_ms_8.png

Enter your python version.

Note

Please type in your python version in the major.minor format, which means to give 3.X if you have the version 3.X.YY. E.g. 3.9 if you have the python version 3.9.13.

_images/sesmg_installation_ms_9.png

  1. Have fun with the SESMG.

_images/sesmg_installation_ms_10.png

Note

If you receive a “Your computer has been protected by Windows” error message, click “More Information,” and then “Run Anyway”.

MacOS

Note

We recommend installing the SESMG as an admin or user with admin rights.

  1. Install Python (version 3.8 or 3.9)

Go to the Python download page for macOS and download an installer.

Note

Make sure to use the installer referring to your chip (Intel-only or universal2) version (e.g. “macOS 64-bit universal2 installer” for mac with Apple M1 / M2). You can check the kind of buil in chip by opening the “About this Mac” option behind the apple icon in the above left corner.

Note

The SESMG is not compatible with the python version 3.9.7, due to a confliciting bug in this version to the subpackage streamlit. You need do install another pyhton version or update to another python version e. g. 3.9.13, which is widely tested.

_images/sesmg_installation_ms_1.png

Execute the installer on your computer.

Note

Make sure to select “Add pyton to PATH” at the beginning of the Python installation.

  1. Download the Spreadsheet Energy System Model Generator from GitHub as .zip folder and extract the .zip folder into any directory on the computer.

_images/sesmg_installation_ms_3.png

Note

If your device does not have homebrew installed, install it by typing /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" in your terminal.

Note

Homebrew requires Xcode command line tools for macOS. Check if you already have it installed by using xcode-select --help. If no error occures it is already installed. Otherwise run xcode-select --install in your terminal.

Note

For Apple CPU M1/M2: Make sure to follow the instrutions while installing homebrew. If there is a message to run two lines of code: do so and run them separately in your terminal. Look for: (echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> /Users/YOURUSERNAME/.zprofile and eval “$(/opt/homebrew/bin/brew shellenv)”`` with your username. Do not run those lines if not requested.

  1. Excecute the “MacOS_installation.command” file and enter your python version to the terminal.

_images/sesmg_installation_mac_1.png

Note

You have to confirm the file run in your mac’s security settings to be able to run it. Confirm with ‘Open Anyway’.

_images/sesmg_installation_mac_3.png

Enter your python version.

Note

Please type in your python version in the major.minor format, which means to give 3.X if you have the version 3.X.YY. E.g. 3.9 if you have the python version 3.9.13.

_images/sesmg_installation_mac_2.png

Note

During this step, the cbc solver was automatically installed. The gurobi solver may be used as alternative to the cbc solver. Be aware, that the gurobi-solver is not open-source and a license is required. However, the gurobi may be faster for certain types of optimization problems, especially for those containing binary decisions. The installation procedure of the gurobi solver is described in detail here: https://www.gurobi.com/documentation/quickstart.html

  1. The Spreadsheet Energy System Model Generator has been installed. Have fun with the SESMG.

_images/sesmg_installation_ms_10.png

Note

When running the SESMG for the first time using the Run_SESMG_for_macos.command file you may need to conform again, as described above, in the security settings.

Linux

  1. Install Python (version 3.8 or 3.9)

1.1 Make sure a Python 3 Version is installed:

$ python3 --version

Note

The SESMG is not compatible with the python version 3.9.7, due to a confliciting bug in this version to the subpackage streamlit. You need do install another pyhton version or update to another python version e. g. 3.9.13, which is widely tested.

  1. Download the Spreadsheet Energy System Model Generator from GitHub as .zip folder and extract the .zip folder into any directory on the computer.

_images/sesmg_installation_ms_3.png

Note

If no packages have ever been installed on the computer using apt-get, sudo apt-get update must be executed first.

  1. Install pip:

$ sudo apt-get install python3-pip

  1. Install Graphviz:

$ sudo apt-get install graphviz

  1. Install the CBC Solver:

$ sudo apt-get install coinor-cbc

  1. Install the libpq-dev to avoid a psycopg2 error:

$ sudo apt-get install libpq-dev

The gurobi solver may be used as alternative to the cbc solver. Be aware, that the gurobi-solver is not open-source and a license is required. However, the gurobi may be faster for certain types of optimization problems, especially for those containing binary decisions. The installation procedure of the gurobi solver is described in detail here: https://www.gurobi.com/documentation/quickstart.html

  1. Execute the “Linux_installtion.sh” file. By first navigating to the path of the SESMG directory and then running the following:

$ sudo sh Linux_installation.sh

Enter your python version.

Note

Please type in your python version in the major.minor format, which means to give 3.X if you have the version 3.X.YY. E.g. 3.9 if you have the python version 3.9.13.

  1. The Spreadsheet Energy System Model Generator has been installed. Open a browser and open up: localhost:8501.