Installation

The subsequently described installation steps are demonstrated as shell commands. To use them in your shell, copy all but the initial $ symbol.

Clone the Repository

First of all, clone the gb-dispatch-model repository using the version control system git in the command line.

$ git clone https://github.com/open-energy-transition/gb-dispatch-model.git

Create working environment

gb-dispatch-model relies on a set of other Python packages to function. We manage these using pixi. Once pixi is installed, you can activate the project environment (gb-model) for your operating system and have access to all the PyPSA-Eur dependencies from the command line:

$ pixi -e gb-model shell

Tip

You can also set up automatic shell activation in several popular editors (e.g. in VSCode or Zed). Refer to the pixi documentation for the most up-to-date options.

Note

We don’t currently support linux operating systems using ARM processors since certain packages, such as PySCIPOpt, require being built from source.

Access API keys

For successful execution, you will need the ENTSO-E Transparency platform API key, stored in a .env file in your working directory. To get this key, first create an ENTSO-E transparency platform account. Then, contact the ENTSO-E helpdesk by emailing transparency@entsoe.eu with the email subject Restful API access and email body being just the email address associated with your account.

Your .env file should then look like:

ENTSO_E_API_KEY=<your-api-key-here>