Installation#

Requirements#

Python 3.11
conda or mamba
A linear solver: Gurobi (recommended) or HiGHS (open-source, no licence needed)

Get the code#

Clone the repository:

git clone https://github.com/BertoGBG/GLS_greenbubble.git
cd GLS_greenbubble

Create the environment#

Two installation paths are available.

Option A — Locked environment (recommended)

Locked environments pin every package to an exact version, guaranteeing reproducibility across machines.

1. Add conda-forge and enable strict channel priority (once per machine):

conda config --add channels conda-forge
conda config --set channel_priority strict

2. Install conda-lock (once):

conda install -n base -c conda-forge conda-lock
conda update conda

3. Create the environment from the lock file for your platform:

# macOS Apple Silicon
conda-lock install -n greenbubble-pypsa107 --platform osx-arm64 envs/locks/conda-lock-osx-arm64.yml

# macOS Intel
conda-lock install -n greenbubble-pypsa107 --platform osx-64 envs/locks/conda-lock-osx-64.yml

# Linux
conda-lock install -n greenbubble-pypsa107 --platform linux-64 envs/locks/conda-lock-linux-64.yml

# Windows
conda-lock install -n greenbubble-pypsa107 --platform win-64 envs/locks/conda-lock-win-64.yml

Warning

For Windows users: enable long path support

Snakemake encodes output file paths as long filenames in its metadata directory. Windows enforces a 260-character path limit by default, which can cause [WinError 3] errors during workflow execution. In that case you must enable long path support before running.

Option A — PowerShell (run as Administrator):

Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem" `
    -Name "LongPathsEnabled" -Value 1

Option B — Registry editor:

Navigate to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem and set LongPathsEnabled to 1.

Restart your machine after applying either option.

4. Activate:

conda activate greenbubble-pypsa107

Option B — Unlocked environment (fallback)

Use this if the lock files are unavailable or the locked install fails on your platform. The unlocked file specifies minimum versions and lets conda resolve the exact packages itself, so results may vary slightly between machines.

conda config --add channels conda-forge
conda config --set channel_priority strict
conda env create -f envs/environment-pypsa-1.0.7.yaml
conda activate greenbubble-pypsa107

Solver setup#

Gurobi (recommended for large problems)

Gurobi requires a valid licence. Free academic licences are available at https://www.gurobi.com/academia/academic-program-and-licenses/. Once installed, set optimization.solver: 'gurobi' in config/config.yaml (see Running the Model with Snakemake).

HiGHS (open-source, no licence needed)

HiGHS is included in the conda environment. Set optimization.solver: 'highs' in config/config.yaml (see Running the Model with Snakemake) to use it. Suitable for smaller or exploratory runs.

Running the model#

Run with Snakemake:

# Preview the execution plan without running
snakemake -n

# Run the full workflow with 4 parallel jobs
snakemake -j4

# Force re-run of a specific rule
snakemake -j1 --forcerun preprocess_inputs

See Rules Overview for a description of each step.

Updating input data#

Preprocessed input data (electricity prices, capacity factors, etc.) is downloaded automatically by Snakemake the first time you run the workflow. To refresh the data for a specific year:

snakemake -j1 --forcerun preprocess_inputs

To re-download all years (stochastic mode):

rm -rf data/Inputs_20*/
snakemake -j4

Installation

Contents