Requirements

Contents

Requirements#

For a successful workflow run, the correct python environment, with all of the python package dependencies included, is required.[1]

Our suggestion is adopting the package manager mamba (or conda), which for the installation instructions are provided in the Miniforge GitHub repository, as well as in the PyPSA-Earth documentation.

  • There is no need for the BAU:

mamba create -n 'new_venv'
mamba activate new_venv
pip install -r requirements.txt

when installing the package dependencies, since the

mamba env create -f envs/environment.yaml

takes care of both the correct venv creation, and the packages installation. The only package requiring pip is the highspy solver. We highly recommend using highspy, and for that pip is needed:

sudo apt install python3-pip -y
pip install highspy

Python and Jupyter Notebooks (.ipynb) are optimally used in an IDE.

Our recommendation is VSCode[2], together with the Jupyter extension.

Git#

To follow this tutorial, basic usage of Git is a pre requirement. It is strongly recommended to refresh[3] your Git basics, before moving forwards.

Besides the aforementioned Atlassian source, this is the PyPSA Earth Git reference, and these are some fun, information rich, YouTube Git video tutorials: