Note
If you have not done it yet, follow the :ref:`installation` steps first.
In this tutorial, we will build a heavily simplified power system model for Belgium. But before getting started with PyPSA-Eur it makes sense to be familiar with its general modelling framework PyPSA.
Running the tutorial requires limited computational resources compared to the
full model, which allows the user to explore most of its functionalities on a
local machine. The tutorial will cover examples on how to configure and
customise the PyPSA-Eur model and run the snakemake workflow step by step
from network creation to the solved network. The configuration for the tutorial
is located at config/test/config.electricity.yaml. It includes parts deviating from
the default config file config/config.default.yaml. To run the tutorial with this
configuration, execute
snakemake -call results/test-elec/networks/elec_s_6_ec_lcopt_.nc --configfile config/test/config.electricity.yamlThis configuration is set to download a reduced cutout via the rule :mod:`retrieve_cutout`. For more information on the data dependencies of PyPSA-Eur, continue reading :ref:`data`.
The model can be adapted to only include selected countries (e.g. Belgium) instead of all European countries to limit the spatial scope.
.. literalinclude:: ../config/test/config.electricity.yaml :language: yaml :start-at: countries: :end-before: snapshots:
Likewise, the example's temporal scope can be restricted (e.g. to a single week).
.. literalinclude:: ../config/test/config.electricity.yaml :language: yaml :start-at: snapshots: :end-before: electricity:
It is also possible to allow less or more carbon-dioxide emissions. Here, we limit the emissions of Belgium to 100 Mt per year.
.. literalinclude:: ../config/test/config.electricity.yaml :language: yaml :start-at: electricity: :end-before: extendable_carriers:
PyPSA-Eur also includes a database of existing conventional powerplants. We can select which types of existing powerplants we like to be extendable:
.. literalinclude:: ../config/test/config.electricity.yaml :language: yaml :start-at: extendable_carriers: :end-before: renewable_carriers:
To accurately model the temporal and spatial availability of renewables such as wind and solar energy, we rely on historical weather data. It is advisable to adapt the required range of coordinates to the selection of countries.
.. literalinclude:: ../config/test/config.electricity.yaml :language: yaml :start-at: atlite: :end-before: renewable:
We can also decide which weather data source should be used to calculate potentials and capacity factor time-series for each carrier. For example, we may want to use the ERA-5 dataset for solar and not the default SARAH-2 dataset.
.. literalinclude:: ../config/test/config.electricity.yaml :language: yaml :start-at: solar: :end-at: cutout:
Finally, it is possible to pick a solver. For instance, this tutorial uses the open-source solver GLPK.
.. literalinclude:: ../config/test/config.electricity.yaml :language: yaml :start-at: solver: :end-before: plotting:
Note, that config/test/config.electricity.yaml only includes changes relative to
the default configuration. There are many more configuration options, which are
documented at :ref:`config`.
Open a terminal, go into the PyPSA-Eur directory, and activate the pypsa-eur environment with
mamba activate pypsa-eurLet's say based on the modifications above we would like to solve a very simplified model clustered down to 6 buses and every 24 hours aggregated to one snapshot. The command
snakemake -call results/test-elec/networks/elec_s_6_ec_lcopt_.nc --configfile config/test/config.electricity.yamlorders snakemake to run the rule :mod:`solve_network` that produces the solved network and stores it in results/networks with the name elec_s_6_ec_lcopt_.nc:
.. literalinclude:: ../rules/solve_electricity.smk :start-at: rule solve_network: :end-before: rule solve_operations_network:
This triggers a workflow of multiple preceding jobs that depend on each rule's inputs and outputs:
.. graphviz::
:class: full-width
:align: center
digraph snakemake_dag {
graph[bgcolor=white, margin=0];
node[shape=box, style=rounded, fontname=sans, fontsize=10, penwidth=2];
edge[penwidth=2, color=grey];
0[label = "solve_network", color = "0.21 0.6 0.85", style="rounded"];
1[label = "prepare_network\nll: copt\nopts: ", color = "0.51 0.6 0.85", style="rounded"];
2[label = "add_extra_components", color = "0.43 0.6 0.85", style="rounded"];
3[label = "cluster_network\nclusters: 6", color = "0.17 0.6 0.85", style="rounded"];
4[label = "simplify_network\nsimpl: ", color = "0.49 0.6 0.85", style="rounded"];
5[label = "add_electricity", color = "0.26 0.6 0.85", style="rounded"];
6[label = "build_renewable_profiles\ntechnology: solar", color = "0.02 0.6 0.85", style="rounded"];
7[label = "base_network", color = "0.35 0.6 0.85", style="rounded"];
8[label = "build_shapes", color = "0.62 0.6 0.85", style="rounded"];
9[label = "retrieve_databundle", color = "0.24 0.6 0.85", style="rounded"];
10[label = "retrieve_cutout\ncutout: be-03-2013-era5", color = "0.36 0.6 0.85", style="rounded"];
11[label = "build_renewable_profiles\ntechnology: solar-hsat", color = "0.02 0.6 0.85", style="rounded"];
12[label = "build_renewable_profiles\ntechnology: onwind", color = "0.02 0.6 0.85", style="rounded"];
13[label = "build_renewable_profiles\ntechnology: offwind-ac", color = "0.02 0.6 0.85", style="rounded"];
14[label = "build_ship_raster", color = "0.08 0.6 0.85", style="rounded"];
15[label = "retrieve_ship_raster", color = "0.28 0.6 0.85", style="rounded"];
16[label = "build_renewable_profiles\ntechnology: offwind-dc", color = "0.02 0.6 0.85", style="rounded"];
17[label = "build_renewable_profiles\ntechnology: offwind-float", color = "0.02 0.6 0.85", style="rounded"];
18[label = "build_line_rating", color = "0.07 0.6 0.85", style="rounded"];
19[label = "retrieve_cost_data\nyear: 2030", color = "0.47 0.6 0.85", style="rounded"];
20[label = "build_powerplants", color = "0.11 0.6 0.85", style="rounded"];
21[label = "build_electricity_demand", color = "0.05 0.6 0.85", style="rounded"];
22[label = "retrieve_electricity_demand", color = "0.58 0.6 0.85", style="rounded"];
23[label = "retrieve_synthetic_electricity_demand", color = "0.11 0.6 0.85", style="rounded"];
1 -> 0
2 -> 1
19 -> 1
3 -> 2
19 -> 2
4 -> 3
19 -> 3
5 -> 4
19 -> 4
7 -> 4
6 -> 5
11 -> 5
12 -> 5
13 -> 5
16 -> 5
17 -> 5
7 -> 5
18 -> 5
19 -> 5
20 -> 5
21 -> 5
8 -> 5
7 -> 6
9 -> 6
8 -> 6
10 -> 6
8 -> 7
9 -> 8
7 -> 11
9 -> 11
8 -> 11
10 -> 11
7 -> 12
9 -> 12
8 -> 12
10 -> 12
7 -> 13
9 -> 13
14 -> 13
8 -> 13
10 -> 13
15 -> 14
10 -> 14
7 -> 16
9 -> 16
14 -> 16
8 -> 16
10 -> 16
7 -> 17
9 -> 17
14 -> 17
8 -> 17
10 -> 17
7 -> 18
10 -> 18
7 -> 20
22 -> 21
23 -> 21
}
In the terminal, this will show up as a list of jobs to be run:
Building DAG of jobs...
Job stats:
job count
------------------------------------- -------
add_electricity 1
add_extra_components 1
base_network 1
build_electricity_demand 1
build_line_rating 1
build_powerplants 1
build_renewable_profiles 6
build_shapes 1
build_ship_raster 1
cluster_network 1
prepare_network 1
retrieve_cost_data 1
retrieve_cutout 1
retrieve_databundle 1
retrieve_electricity_demand 1
retrieve_ship_raster 1
retrieve_synthetic_electricity_demand 1
simplify_network 1
solve_network 1
total 24snakemake then runs these jobs in the correct order.
A job (here simplify_network) will display its attributes and normally some logs below this block:
rule simplify_network:
input: resources/test/networks/elec.nc, resources/test/costs_2030.csv, resources/test/regions_onshore.geojson, resources/test/regions_offshore.geojson
output: resources/test/networks/elec_s.nc, resources/test/regions_onshore_elec_s.geojson, resources/test/regions_offshore_elec_s.geojson, resources/test/busmap_elec_s.csv
log: logs/test/simplify_network/elec_s.log
jobid: 4
benchmark: benchmarks/test/simplify_network/elec_s
reason: Forced execution
wildcards: simpl=
resources: tmpdir=<TBD>, mem_mb=12000, mem_mib=11445Once the whole worktree is finished, it should state so in the terminal.
You will notice that many intermediate stages are saved, namely the outputs of each individual snakemake rule.
You can produce any output file occurring in the Snakefile by running
snakemake -call <output file>For example, you can explore the evolution of the PyPSA networks by running
snakemake resources/networks/base.nc -call --configfile config/test/config.electricity.yamlsnakemake resources/networks/elec.nc -call --configfile config/test/config.electricity.yamlsnakemake resources/networks/elec_s.nc -call --configfile config/test/config.electricity.yamlsnakemake resources/networks/elec_s_6.nc -call --configfile config/test/config.electricity.yamlsnakemake resources/networks/elec_s_6_ec_lcopt_.nc -call --configfile config/test/config.electricity.yaml
To run all combinations of wildcard values provided in the config/config.yaml under scenario:,
you can use the collection rule solve_elec_networks.
snakemake -call solve_elec_networks --configfile config/test/config.electricity.yamlIf you now feel confident and want to tackle runs with larger temporal and
spatial scope, clean-up the repository and after modifying the config/config.yaml file
target the collection rule solve_elec_networks again without providing the test
configuration file.
snakemake -call purge
snakemake -call solve_elec_networksNote
It is good practice to perform a dry-run using the option -n, before you commit to a run:
snakemake -call solve_elec_networks -nThe solved networks can be analysed just like any other PyPSA network (e.g. in Jupyter Notebooks).
import pypsa
n = pypsa.Network("results/networks/elec_s_6_ec_lcopt_.nc")For inspiration, read the examples section in the PyPSA documentation.