documentation updates
This commit is contained in:
Fabian Neumann
parent
93d462831d
commit
b6732bf6c4
@ -136,6 +136,7 @@ html_theme = "sphinx_book_theme"
|
||||
html_theme_options = {
|
||||
"repository_url": "https://github.com/pypsa/pypsa-eur",
|
||||
"use_repository_button": True,
|
||||
"show_navbar_depth": 2,
|
||||
}
|
||||
|
||||
|
||||
@ -144,7 +145,7 @@ html_theme_options = {
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
html_title = "PyPSA-Eur: An Open Optimisation Model of the European Transmission System"
|
||||
html_title = "PyPSA-Eur"
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
# html_short_title = None
|
||||
@ -159,7 +160,7 @@ html_logo = "img/pypsa-logo.png"
|
||||
# html_favicon = None
|
||||
|
||||
# These folders are copied to the documentation's HTML output
|
||||
html_static_path = ["_static"]
|
||||
# html_static_path = ["_static"]
|
||||
|
||||
# These paths are either relative to html_static_path
|
||||
# or fully qualified paths (eg. https://...)
|
||||
|
||||
@ -52,7 +52,7 @@ facilitate running multiple scenarios through a single command
|
||||
|
||||
.. code:: bash
|
||||
|
||||
snakemake -j 1 solve_all_networks
|
||||
snakemake -call solve_all_networks
|
||||
|
||||
For each wildcard, a **list of values** is provided. The rule ``solve_all_networks`` will trigger the rules for creating ``results/networks/elec_s{simpl}_{clusters}_ec_l{ll}_{opts}.nc`` for **all combinations** of the provided wildcard values as defined by Python's `itertools.product(...) <https://docs.python.org/2/library/itertools.html#itertools.product>`_ function that snakemake's `expand(...) function <https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#targets>`_ uses.
|
||||
|
||||
@ -192,7 +192,7 @@ Define and specify the ``atlite.Cutout`` used for calculating renewable potentia
|
||||
.. _lines_cf:
|
||||
|
||||
``conventional``
|
||||
=============
|
||||
================
|
||||
|
||||
Define additional generator attribute for conventional carrier types. If a scalar value is given it is applied to all generators. However if a string starting with "data/" is given, the value is interpreted as a path to a csv file with country specific values. Then, the values are read in and applied to all generators of the given carrier in the given country. Note that the value(s) overwrite the existing values in the corresponding section of the ``generators`` dataframe.
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 206 KiB |
@ -28,17 +28,18 @@ For instance an invocation to
|
||||
|
||||
.. code:: bash
|
||||
|
||||
.../pypsa-eur % snakemake -j 1 networks/elec_s_128.nc
|
||||
.../pypsa-eur % snakemake -call results/networks/elec_s_128_ec_lvopt_Co2L-3H.nc
|
||||
|
||||
follows this dependency graph:
|
||||
|
||||
.. image:: img/workflow.png
|
||||
:class: full-width
|
||||
|
||||
The **blocks** represent the individual rules which are required to create the file ``networks/elec_s_128.nc``. The **arrows** indicate the outputs from preceding rules which a particular rule takes as input data.
|
||||
|
||||
.. note::
|
||||
The dependency graph shown above was generated using
|
||||
``snakemake --dag networks/elec_s_128.nc | dot -Tpng > workflow.png``
|
||||
``snakemake --dag results/networks/elec_s_128_ec_lvopt_Co2L-3H.nc -F | sed -n "/digraph/,/}/p" | dot -Tpng -o workflow.png``
|
||||
|
||||
For the use of ``snakemake``, it makes sense to familiarize oneself quickly with its `basic tutorial <https://snakemake.readthedocs.io/en/stable/tutorial/basics.html>`_ and then read carefully through the section `Executing Snakemake <https://snakemake.readthedocs.io/en/stable/executable.html>`_, noting the arguments ``-j``, ``-n``, ``-r``, but also ``--dag``, ``-R`` and ``-t``.
|
||||
|
||||
|
||||
@ -111,7 +111,7 @@ This rule downloads techno-economic assumptions from the `technology-data reposi
|
||||
|
||||
.. seealso::
|
||||
Documentation of the configuration file ``config.yaml`` at
|
||||
:ref:`_costs_cf`
|
||||
:ref:`costs_cf`
|
||||
|
||||
**Outputs**
|
||||
|
||||
|
||||
@ -84,27 +84,20 @@ PyPSA-Eur 0.5.0 (27th July 2022)
|
||||
**New Features**
|
||||
|
||||
* New network topology extracted from the ENTSO-E interactive map.
|
||||
|
||||
* Added existing renewable capacities for all countries based on IRENA
|
||||
statistics (IRENASTAT) using new ``powerplantmatching`` version:
|
||||
* The corresponding ``config`` entries changed, cf. ``config.default.yaml``:
|
||||
* old: ``estimate_renewable_capacities_from_capacity_stats``
|
||||
* new: ``estimate_renewable_capacities``
|
||||
* The estimation is endabled by setting the subkey ``enable`` to ``True``.
|
||||
* Configuration of reference year for capacities can be configured (default:
|
||||
``2020``)
|
||||
* The list of renewables provided by the OPSD database can be used as a basis,
|
||||
using the tag ``from_opsd: True``. This adds the renewables from the
|
||||
database and fills up the missing capacities with the heuristic
|
||||
distribution.
|
||||
* Uniform expansion limit of renewable build-up based on existing capacities
|
||||
can be configured using ``expansion_limit`` option (default: ``false``;
|
||||
limited to determined renewable potentials)
|
||||
* Distribution of country-level capacities proportional to maximum annual
|
||||
energy yield for each bus region
|
||||
* The config key ``renewable_capacities_from_OPSD`` is deprecated and was moved
|
||||
under the section, ``estimate_renewable_capacities``. To enable it, set
|
||||
``from_opsd`` to ``True``.
|
||||
* The corresponding ``config`` entries changed from ``estimate_renewable_capacities_from_capacity_stats`` to ``estimate_renewable_capacities``.
|
||||
* The estimation is endabled by setting the subkey ``enable`` to ``True``.
|
||||
* Configuration of reference year for capacities can be configured (default: ``2020``)
|
||||
* The list of renewables provided by the OPSD database can be used as a basis, using the tag ``from_opsd: True``. This adds the renewables from the database and fills up the missing capacities with the heuristic distribution.
|
||||
* Uniform expansion limit of renewable build-up based on existing capacities
|
||||
can be configured using ``expansion_limit`` option (default: ``false``;
|
||||
limited to determined renewable potentials)
|
||||
* Distribution of country-level capacities proportional to maximum annual
|
||||
energy yield for each bus region
|
||||
* The config key ``renewable_capacities_from_OPSD`` is deprecated and was moved
|
||||
under the section, ``estimate_renewable_capacities``. To enable it, set
|
||||
``from_opsd`` to ``True``.
|
||||
|
||||
* Add operational reserve margin constraint analogous to `GenX implementation
|
||||
<https://genxproject.github.io/GenX/dev/core/#Reserves>`_. Can be activated
|
||||
@ -566,7 +559,7 @@ Release Process
|
||||
|
||||
* Update ``envs/environment.fixed.yaml`` via
|
||||
``conda env export -n pypsa-eur -f envs/environment.fixed.yaml --no-builds``
|
||||
from an up-to-date `pypsa-eur` environment.
|
||||
from an up-to-date ``pypsa-eur`` environment.
|
||||
|
||||
* Update version number in ``doc/conf.py``, ``CITATION.cff`` and ``*config.*.yaml``.
|
||||
|
||||
@ -577,7 +570,7 @@ Release Process
|
||||
|
||||
* Upload code to `zenodo code repository <https://doi.org/10.5281/zenodo.3520874>`_ with `MIT license <https://opensource.org/licenses/MIT>`_.
|
||||
|
||||
* Create pre-built networks for ``config.default.yaml`` by running ``snakemake -j 1 extra_components_all_networks``.
|
||||
* Create pre-built networks for ``config.default.yaml`` by running ``snakemake -call extra_components_all_networks``.
|
||||
|
||||
* Upload pre-built networks to `zenodo data repository <https://doi.org/10.5281/zenodo.3601881>`_ with `CC BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ license.
|
||||
|
||||
|
||||
128
doc/tutorial.rst
128
doc/tutorial.rst
@ -62,7 +62,7 @@ It is also possible to allow less or more carbon-dioxide emissions. Here, we lim
|
||||
.. literalinclude:: ../config.tutorial.yaml
|
||||
:language: yaml
|
||||
:start-at: electricity:
|
||||
:end-before: exentable_carriers:
|
||||
:end-before: extendable_carriers:
|
||||
|
||||
PyPSA-Eur also includes a database of existing conventional powerplants.
|
||||
We can select which types of powerplants we like to be included:
|
||||
@ -124,7 +124,7 @@ clustered down to 6 buses and every 24 hours aggregated to one snapshot. The com
|
||||
|
||||
.. code:: bash
|
||||
|
||||
.../pypsa-eur % snakemake -j 1 results/networks/elec_s_6_ec_lcopt_Co2L-24H.nc
|
||||
.../pypsa-eur % snakemake -call results/networks/elec_s_6_ec_lcopt_Co2L-24H.nc
|
||||
|
||||
orders ``snakemake`` to run the script ``solve_network`` that produces the solved network and stores it in ``.../pypsa-eur/results/networks`` with the name ``elec_s_6_ec_lcopt_Co2L-24H.nc``:
|
||||
|
||||
@ -135,56 +135,96 @@ orders ``snakemake`` to run the script ``solve_network`` that produces the solve
|
||||
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];
|
||||
node[shape=box, style=rounded, fontname=sans, fontsize=10, penwidth=2];
|
||||
edge[penwidth=2, color=grey];
|
||||
0[label = "solve_network", color = "0.10 0.6 0.85", style="rounded"];
|
||||
1[label = "prepare_network\nll: copt\nopts: Co2L-24H", color = "0.13 0.6 0.85", style="rounded"];
|
||||
2[label = "cluster_network\nclusters: 6", color = "0.51 0.6 0.85", style="rounded"];
|
||||
3[label = "simplify_network\nnetwork: elec\nsimpl: ", color = "0.00 0.6 0.85", style="rounded"];
|
||||
4[label = "add_electricity", color = "0.60 0.6 0.85", style="rounded"];
|
||||
5[label = "build_bus_regions", color = "0.19 0.6 0.85", style="rounded"];
|
||||
6[label = "base_network", color = "0.38 0.6 0.85", style="rounded"];
|
||||
7[label = "build_shapes", color = "0.03 0.6 0.85", style="rounded"];
|
||||
8[label = "build_renewable_profiles\ntechnology: onwind", color = "0.48 0.6 0.85", style="rounded"];
|
||||
9[label = "build_renewable_profiles\ntechnology: offwind-ac", color = "0.48 0.6 0.85", style="rounded"];
|
||||
10[label = "build_renewable_profiles\ntechnology: offwind-dc", color = "0.48 0.6 0.85", style="rounded"];
|
||||
11[label = "build_renewable_profiles\ntechnology: solar", color = "0.48 0.6 0.85", style="rounded"];
|
||||
12[label = "build_cutout\ncutout: europe-2013-era5", color = "0.35 0.6 0.85", style="rounded,dashed"];
|
||||
0[label = "solve_network", color = "0.21 0.6 0.85", style="rounded"];
|
||||
1[label = "prepare_network\nll: copt\nopts: Co2L-24H", color = "0.02 0.6 0.85", style="rounded"];
|
||||
2[label = "add_extra_components", color = "0.37 0.6 0.85", style="rounded"];
|
||||
3[label = "cluster_network\nclusters: 6", color = "0.39 0.6 0.85", style="rounded"];
|
||||
4[label = "simplify_network\nsimpl: ", color = "0.11 0.6 0.85", style="rounded"];
|
||||
5[label = "add_electricity", color = "0.23 0.6 0.85", style="rounded"];
|
||||
6[label = "build_renewable_profiles\ntechnology: onwind", color = "0.57 0.6 0.85", style="rounded"];
|
||||
7[label = "base_network", color = "0.09 0.6 0.85", style="rounded"];
|
||||
8[label = "build_shapes", color = "0.41 0.6 0.85", style="rounded"];
|
||||
9[label = "retrieve_databundle", color = "0.28 0.6 0.85", style="rounded"];
|
||||
10[label = "retrieve_natura_raster", color = "0.62 0.6 0.85", style="rounded"];
|
||||
11[label = "build_bus_regions", color = "0.53 0.6 0.85", style="rounded"];
|
||||
12[label = "retrieve_cutout\ncutout: europe-2013-era5", color = "0.05 0.6 0.85", style="rounded,dashed"];
|
||||
13[label = "build_renewable_profiles\ntechnology: offwind-ac", color = "0.57 0.6 0.85", style="rounded"];
|
||||
14[label = "build_ship_raster", color = "0.64 0.6 0.85", style="rounded"];
|
||||
15[label = "retrieve_ship_raster", color = "0.07 0.6 0.85", style="rounded,dashed"];
|
||||
16[label = "retrieve_cutout\ncutout: europe-2013-sarah", color = "0.05 0.6 0.85", style="rounded,dashed"];
|
||||
17[label = "build_renewable_profiles\ntechnology: offwind-dc", color = "0.57 0.6 0.85", style="rounded"];
|
||||
18[label = "build_renewable_profiles\ntechnology: solar", color = "0.57 0.6 0.85", style="rounded"];
|
||||
19[label = "build_hydro_profile", color = "0.44 0.6 0.85", style="rounded"];
|
||||
20[label = "retrieve_cost_data", color = "0.30 0.6 0.85", style="rounded"];
|
||||
21[label = "build_powerplants", color = "0.16 0.6 0.85", style="rounded"];
|
||||
22[label = "build_load_data", color = "0.00 0.6 0.85", style="rounded"];
|
||||
23[label = "retrieve_load_data", color = "0.34 0.6 0.85", style="rounded,dashed"];
|
||||
1 -> 0
|
||||
2 -> 1
|
||||
20 -> 1
|
||||
3 -> 2
|
||||
20 -> 2
|
||||
4 -> 3
|
||||
5 -> 3
|
||||
6 -> 4
|
||||
20 -> 3
|
||||
5 -> 4
|
||||
7 -> 4
|
||||
8 -> 4
|
||||
9 -> 4
|
||||
10 -> 4
|
||||
20 -> 4
|
||||
11 -> 4
|
||||
7 -> 5
|
||||
6 -> 5
|
||||
13 -> 5
|
||||
17 -> 5
|
||||
18 -> 5
|
||||
19 -> 5
|
||||
7 -> 5
|
||||
20 -> 5
|
||||
11 -> 5
|
||||
21 -> 5
|
||||
9 -> 5
|
||||
22 -> 5
|
||||
8 -> 5
|
||||
7 -> 6
|
||||
6 -> 8
|
||||
7 -> 8
|
||||
5 -> 8
|
||||
12 -> 8
|
||||
6 -> 9
|
||||
7 -> 9
|
||||
5 -> 9
|
||||
12 -> 9
|
||||
6 -> 10
|
||||
7 -> 10
|
||||
5 -> 10
|
||||
12 -> 10
|
||||
6 -> 11
|
||||
9 -> 6
|
||||
10 -> 6
|
||||
8 -> 6
|
||||
11 -> 6
|
||||
12 -> 6
|
||||
8 -> 7
|
||||
9 -> 8
|
||||
8 -> 11
|
||||
7 -> 11
|
||||
5 -> 11
|
||||
12 -> 11
|
||||
7 -> 13
|
||||
9 -> 13
|
||||
10 -> 13
|
||||
14 -> 13
|
||||
8 -> 13
|
||||
11 -> 13
|
||||
12 -> 13
|
||||
15 -> 14
|
||||
12 -> 14
|
||||
16 -> 14
|
||||
7 -> 17
|
||||
9 -> 17
|
||||
10 -> 17
|
||||
14 -> 17
|
||||
8 -> 17
|
||||
11 -> 17
|
||||
12 -> 17
|
||||
7 -> 18
|
||||
9 -> 18
|
||||
10 -> 18
|
||||
8 -> 18
|
||||
11 -> 18
|
||||
16 -> 18
|
||||
8 -> 19
|
||||
12 -> 19
|
||||
7 -> 21
|
||||
23 -> 22
|
||||
}
|
||||
|
||||
|
|
||||
@ -242,15 +282,15 @@ You can produce any output file occurring in the ``Snakefile`` by running
|
||||
|
||||
.. code:: bash
|
||||
|
||||
.../pypsa-eur % snakemake -j 1 <output file>
|
||||
.../pypsa-eur % snakemake -call <output file>
|
||||
|
||||
For example, you can explore the evolution of the PyPSA networks by running
|
||||
|
||||
#. ``.../pypsa-eur % snakemake -j 1 networks/base.nc``
|
||||
#. ``.../pypsa-eur % snakemake -j 1 networks/elec.nc``
|
||||
#. ``.../pypsa-eur % snakemake -j 1 networks/elec_s.nc``
|
||||
#. ``.../pypsa-eur % snakemake -j 1 networks/elec_s_6.nc``
|
||||
#. ``.../pypsa-eur % snakemake -j 1 networks/elec_s_6_ec_lcopt_Co2L-24H.nc``
|
||||
#. ``.../pypsa-eur % snakemake -call networks/base.nc``
|
||||
#. ``.../pypsa-eur % snakemake -call networks/elec.nc``
|
||||
#. ``.../pypsa-eur % snakemake -call networks/elec_s.nc``
|
||||
#. ``.../pypsa-eur % snakemake -call networks/elec_s_6.nc``
|
||||
#. ``.../pypsa-eur % snakemake -call networks/elec_s_6_ec_lcopt_Co2L-24H.nc``
|
||||
|
||||
There's a special rule: If you simply run
|
||||
|
||||
|
||||
@ -107,7 +107,7 @@ in Germany (in the solution for Europe) use:
|
||||
|
||||
.. code:: bash
|
||||
|
||||
snakemake -j 1 results/summaries/elec_s_all_lall_Co2L-3H_DE
|
||||
snakemake -call results/summaries/elec_s_all_lall_Co2L-3H_DE
|
||||
|
||||
.. _cutout_wc:
|
||||
|
||||
|
||||
@ -26,15 +26,17 @@ Relevant Settings
|
||||
Inputs
|
||||
------
|
||||
|
||||
- ``data/bundle/shipdensity/shipdensity_global.zip``: `Global ship density from
|
||||
<https://datacatalog.worldbank.org/search/dataset/0037580/Global-Shipping-Traffic-Density>`_.
|
||||
- ``data/bundle/shipdensity/shipdensity_global.zip``: Global shipping traffic
|
||||
density from `World Bank Data Catalogue
|
||||
<https://datacatalog.worldbank.org/search/dataset/0037580/>`_.
|
||||
|
||||
Outputs
|
||||
-------
|
||||
|
||||
- ``resources/europe_shipdensity_raster.nc``: Reduced version of `Global ship
|
||||
density from <https://datacatalog.worldbank.org/search/dataset/0037580/`_ to
|
||||
reduce computation time.
|
||||
- ``resources/europe_shipdensity_raster.nc``: Reduced version of global shipping
|
||||
traffic density from `World Bank Data Catalogue
|
||||
<https://datacatalog.worldbank.org/search/dataset/0037580/>`_ to reduce
|
||||
computation time.
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Loading…
Reference in New Issue
Block a user