Simulation runs of Euro-Calliope within the OSE model comparison.

This repository contains the entire scientific project, including code and report. The philosophy behind this repository is that no intermediary results are included, but all results are computed from raw data and code.

1. Clone the repo. Because euro-calliope is added as a git submodule, you may want to clone using git clone --recurse-submodules <link-to-this-repo>.

2. Create an environment to run the analysis. You need conda to run the analysis. Using conda, you can create a conda environment from within you can run it:

   conda env create -f environment.yaml

3. Make sure you have a Gurobi license, or install and configure another solver.

4. Provide the input data for Euro-Calliope, as defined in "Getting Ready" in ./euro-calliope/README.md.

snakemake --use-conda

This will run all analysis steps to reproduce results and eventually build the report.

You can also run certain parts only by using other snakemake rules; to get a list of all rules run snakemake --list.

To generate a PDF of the dependency graph of all steps, and if you have dot installed, run:

snakemake --rulegraph | dot -Tpdf > dag.pdf

To run on Euler, use the following command:

snakemake --use-conda --profile config/euler [--config email=<[email protected]>]

By providing an email address, you will be informed by mail when Snakemake finishes execution.

If you want to run on another cluster, read snakemake's documentation on cluster execution and take config/euler as a starting point.

snakemake test --use-conda

The default units within the optimisation model are MW, MWh, EUR, Mt, and km2, but you can scale all of these using the configuration values in config/default.yaml. Apart from convenience, this may be important to handle numerical issues with your solver.

• report: contains all files necessary to build the report; plots and result files are not in here but generated automatically
• envs: contains execution environments
• src: contains the Python source code
• tests: contains the test code
• config: configurations used in the study
• data: place for raw data
• build: will contain all results (does not exist initially)