bjoern/pypsa-eur
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

move rules to own pages and adapt image paths

Browse Source
This commit is contained in:
Fabian Neumann 2019-08-14 15:36:46 +02:00
parent 737ffc930d
commit 0e5886081e
35 changed files with 165 additions and 154 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/contributing.rst
View File

@ -7,4 +7,4 @@ be it with new ideas, suggestions, by filing bug reports or contributing code.
You are invited to submit pull requests and file issues to the `GitHub repository <https://github.com/PyPSA/PyPSA-Eur>`_.
If you are unfamiliar with pull requests, the GitHub help pages have a nice `guide <https://help.github.com/en/articles/about-pull-requests>`_.
If you are unfamiliar with pull requests, the GitHub help pages have a nice `guide <https://help.github.com/en/articles/about-pull-requests>`_.

1
doc/index.rst
View File

@ -78,7 +78,6 @@ Documentation
:hidden:
:maxdepth: 1
:caption: Rules Overview
:numbered:
preparation
simplification

88
doc/preparation.rst
View File

@ -23,79 +23,17 @@ Then the process continues by calculating conventional power plant capacities, p
The central rule :mod:`add_electricity` then ties all the different data inputs
together into a detailed PyPSA network stored in ``networks/elec.nc``.
.. _shapes:
.. toctree::
:caption: Overview
Build Shapes
=============================
.. automodule:: build_shapes
.. _cutout:
Build Cutout
=============================
.. automodule:: build_cutout
.. _links:
Prepare HVDC Links
=============================
.. automodule:: prepare_links_p_nom
.. _base:
Base Network
=============================
.. automodule:: base_network
.. _busregions:
Build Bus Regions
=============================
.. automodule:: build_bus_regions
.. _natura:
Build Natura Raster
=============================
.. automodule:: build_natura_raster
.. _flh:
Build Country Full Load Hours
=============================
.. automodule:: build_country_flh
.. _powerplants:
Build Power Plants
=============================
.. automodule:: build_powerplants
.. _renewableprofiles:
Build Renewable Profiles
========================
.. automodule:: build_renewable_profiles
.. _hydroprofiles:
Build Hydro Profile
=============================
.. automodule:: build_hydro_profile
.. _electricity:
Add Electricity
=============================
.. automodule:: add_electricity
preparation/build_shapes
preparation/build_cutout
preparation/prepare_links_p_nom
preparation/base_network
preparation/build_bus_regions
preparation/build_natura_raster
preparation/build_country_flh
preparation/build_powerplants
preparation/build_renewable_profiles
preparation/build_hydro_profile
preparation/add_electricity

6
doc/preparation/add_electricity.rst Normal file
View File

@ -0,0 +1,6 @@
.. _electricity:
Rule :mod:`add_electricity`
=============================
.. automodule:: add_electricity

6
doc/preparation/base_network.rst Normal file
View File

@ -0,0 +1,6 @@
.. _base:
Rule :mod:`base_network`
=============================
.. automodule:: base_network

6
doc/preparation/build_bus_regions.rst Normal file
View File

@ -0,0 +1,6 @@
.. _busregions:
Rule :mod:`build_bus_regions`
=============================
.. automodule:: build_bus_regions

6
doc/preparation/build_country_flh.rst Normal file
View File

@ -0,0 +1,6 @@
.. _flh:
Rule :mod:`build_country_flh`
=============================
.. automodule:: build_country_flh

6
doc/preparation/build_cutout.rst Normal file
View File

@ -0,0 +1,6 @@
.. _cutout:
Rule :mod:`build_cutout`
=============================
.. automodule:: build_cutout

6
doc/preparation/build_hydro_profile.rst Normal file
View File

@ -0,0 +1,6 @@
.. _hydroprofiles:
Rule :mod:`build_hydro_profile`
===============================
.. automodule:: build_hydro_profile

6
doc/preparation/build_natura_raster.rst Normal file
View File

@ -0,0 +1,6 @@
.. _natura:
Rule :mod:`build_natura_raster`
===============================
.. automodule:: build_natura_raster

6
doc/preparation/build_powerplants.rst Normal file
View File

@ -0,0 +1,6 @@
.. _powerplants:
Rule :mod:`build_powerplants`
=============================
.. automodule:: build_powerplants

6
doc/preparation/build_renewable_profiles.rst Normal file
View File

@ -0,0 +1,6 @@
.. _renewableprofiles:
Rule :mod:`build_renewable_profiles`
====================================
.. automodule:: build_renewable_profiles

6
doc/preparation/build_shapes.rst Normal file
View File

@ -0,0 +1,6 @@
.. _shapes:
Rule :mod:`build_shapes`
=============================
.. automodule:: build_shapes

6
doc/preparation/prepare_links_p_nom.rst Normal file
View File

@ -0,0 +1,6 @@
.. _links:
Rule :mod:`prepare_links_p_nom`
===============================
.. automodule:: prepare_links_p_nom

26
doc/simplification.rst
View File

@ -13,23 +13,9 @@ The simplification and clustering steps are described in detail in the paper
- Jonas Hörsch and Tom Brown. `The role of spatial scale in joint optimisations of generation and transmission for European highly renewable scenarios <https://arxiv.org/abs/1705.07617>`_), *14th International Conference on the European Energy Market*, 2017. `arXiv:1705.07617 <https://arxiv.org/abs/1705.07617>`_, `doi:10.1109/EEM.2017.7982024 <https://doi.org/10.1109/EEM.2017.7982024>`_.
.. _simplify:
Simplify Network
================
.. automodule:: simplify_network
.. _cluster:
Cluster Network
===============
.. automodule:: cluster_network
.. _prepare:
Prepare Network
===============
.. automodule:: prepare_network
.. toctree::
:caption: Overview
simplification/simplify_network
simplification/cluster_network
simplification/prepare_network

6
doc/simplification/cluster_network.rst Normal file
View File

@ -0,0 +1,6 @@
.. _cluster:
Rule :mod:`cluster_network`
===========================
.. automodule:: cluster_network

6
doc/simplification/prepare_network.rst Normal file
View File

@ -0,0 +1,6 @@
.. _prepare:
Rule :mod:`prepare_network`
===========================
.. automodule:: prepare_network

6
doc/simplification/simplify_network.rst Normal file
View File

@ -0,0 +1,6 @@
.. _simplify:
Rule :mod:`simplify_network`
============================
.. automodule:: simplify_network

24
doc/solving.rst
View File

@ -4,23 +4,9 @@ Solving Networks
After generating and simplifying the networks they can be solved through the rule :mod:`solve_network` by using the collection rule :mod:`solve_all_elec_networks`. Moreover, networks can be solved for another focus with the derivative rules :mod:`solve_network` by using the collection rule :mod:`trace_solve_network` to log changes during iterations and :mod:`solve_network` by using the collection rule :mod:`solve_operations_network` for dispatch-only analyses on an already solved network.
.. _solve:
.. toctree::
:caption: Overview
Solve Network
=============
.. automodule:: solve_network
.. _trace_solve:
Trace Solve Network
===================
.. automodule:: trace_solve_network
.. _solve_operations:
Solve Operations Network
========================
.. automodule:: solve_operations_network
solving/solve_network
solving/trace_solve_network
solving/solve_operations_network

6
doc/solving/solve_network.rst Normal file
View File

@ -0,0 +1,6 @@
.. _solve:
Rule :mod:`solve_network`
=========================
.. automodule:: solve_network

6
doc/solving/solve_operations_network.rst Normal file
View File

@ -0,0 +1,6 @@
.. _solve_operations:
Rule :mod:`solve_operations_network`
====================================
.. automodule:: solve_operations_network

6
doc/solving/trace_solve_network.rst Normal file
View File

@ -0,0 +1,6 @@
.. _trace_solve:
Rule :mod:`trace_solve_network`
===============================
.. automodule:: trace_solve_network

8
scripts/add_electricity.py
View File

@ -45,16 +45,16 @@ Inputs
- ``data/costs.csv``: The database of cost assumptions for all included technologies for specific years from various sources; e.g. discount rate, lifetime, investment (CAPEX), fixed operation and maintenance (FOM), variable operation and maintenance (VOM), fuel costs, efficiency, carbon-dioxide intensity.
- ``data/bundle/hydro_capacities.csv``: Hydropower plant store/discharge power capacities, energy storage capacity, and average hourly inflow by country.
.. image:: img/hydrocapacities.png
.. image:: ../img/hydrocapacities.png
:scale: 34 %
- ``data/geth2015_hydro_capacities.csv``: alternative to capacities above; NOT CURRENTLY USED!
- ``data/bundle/time_series_60min_singleindex_filtered.csv``: Hourly per-country load profiles since 2010 from the `ENTSO-E statistical database <https://www.entsoe.eu/data/power-stats/hourly_load/>`_
.. image:: img/load-box.png
.. image:: ../img/load-box.png
:scale: 33 %
.. image:: img/load-ts.png
.. image:: ../img/load-ts.png
:scale: 33 %
- ``resources/regions_onshore.geojson``: confer :ref:`busregions`
@ -68,7 +68,7 @@ Outputs
- ``networks/elec.nc``:
.. image:: img/elec.png
.. image:: ../img/elec.png
:scale: 33 %
Description

2
scripts/base_network.py
View File

@ -50,7 +50,7 @@ Outputs
- ``networks/base.nc``
.. image:: img/base.png
.. image:: ../img/base.png
:scale: 33 %
Description

4
scripts/build_bus_regions.py
View File

@ -24,12 +24,12 @@ Outputs
- ``resources/regions_onshore.geojson``:
.. image:: img/regions_onshore.png
.. image:: ../img/regions_onshore.png
:scale: 33 %
- ``resources/regions_offshore.geojson``:
.. image:: img/regions_offshore.png
.. image:: ../img/regions_offshore.png
:scale: 33 %
Description

4
scripts/build_country_flh.py
View File

@ -24,12 +24,12 @@ Inputs
- ``data/bundle/corine/g250_clc06_V18_5.tif``: `CORINE Land Cover (CLC) <https://land.copernicus.eu/pan-european/corine-land-cover>`_ inventory on `44 classes <https://wiki.openstreetmap.org/wiki/Corine_Land_Cover#Tagging>`_ of land use (e.g. forests, arable land, industrial, urban areas).
.. image:: img/corine.png
.. image:: ../img/corine.png
:scale: 33 %
- ``data/bundle/GEBCO_2014_2D.nc``: A `bathymetric <https://en.wikipedia.org/wiki/Bathymetry>`_ data set with a global terrain model for ocean and land at 15 arc-second intervals by the `General Bathymetric Chart of the Oceans (GEBCO) <https://www.gebco.net/data_and_products/gridded_bathymetry_data/>`_.
.. image:: img/gebco_2019_grid_image.jpg
.. image:: ../img/gebco_2019_grid_image.jpg
:scale: 50 %
**Source:** `GEBCO <https://www.gebco.net/data_and_products/images/gebco_2019_grid_image.jpg>`_

4
scripts/build_cutout.py
View File

@ -64,13 +64,13 @@ Outputs
wnd100m time, y, x ms**-1 Wind speeds at 100 meters (regardless of direction)
=================== ========== ========== =========================================================
.. image:: img/era5.png
.. image:: ../img/era5.png
:scale: 40 %
A **SARAH-2 cutout** can be used to amend the fields ``temperature``, ``influx_toa``, ``influx_direct``, ``albedo``,
``influx_diffuse`` of ERA5 using satellite-based radiation observations.
.. image:: img/sarah.png
.. image:: ../img/sarah.png
:scale: 40 %
.. seealso::

6
scripts/build_hydro_profile.py
View File

@ -23,7 +23,7 @@ Inputs
- ``data/bundle/EIA_hydro_generation_2000_2014.csv``: Hydroelectricity net generation per country and year (`EIA <https://www.eia.gov/beta/international/data/browser/#/?pa=000000000000000000000000000000g&c=1028i008006gg6168g80a4k000e0ag00gg0004g800ho00g8&ct=0&ug=8&tl_id=2-A&vs=INTL.33-12-ALB-BKWH.A&cy=2014&vo=0&v=H&start=2000&end=2016>`_)
.. image:: img/hydrogeneration.png
.. image:: ../img/hydrogeneration.png
:scale: 33 %
- ``resources/country_shapes.geojson``: confer :ref:`shapes`
@ -41,10 +41,10 @@ Outputs
e.g. due to river inflow in hydro reservoir.
=================== ================ =========================================================
.. image:: img/inflow-ts.png
.. image:: ../img/inflow-ts.png
:scale: 33 %
.. image:: img/inflow-box.png
.. image:: ../img/inflow-box.png
:scale: 33 %
Description

4
scripts/build_natura_raster.py
View File

@ -19,7 +19,7 @@ Inputs
- ``data/bundle/natura/Natura2000_end2015.shp``: `Natura 2000 <https://en.wikipedia.org/wiki/Natura_2000>`_ natural protection areas.
.. image:: img/natura.png
.. image:: ../img/natura.png
:scale: 33 %
Outputs
@ -27,7 +27,7 @@ Outputs
- ``resources/natura.tiff``: Rasterized version of `Natura 2000 <https://en.wikipedia.org/wiki/Natura_2000>`_ natural protection areas to reduce computation times.
.. image:: img/natura.png
.. image:: ../img/natura.png
:scale: 33 %
Description

2
scripts/build_powerplants.py
View File

@ -24,7 +24,7 @@ Outputs
- ``resource/powerplants.csv``: A list of conventional power plants (i.e. neither wind nor solar) with fields for name, fuel type, technology, country, capacity in MW, duration, commissioning year, retrofit year, latitude, longitude, and dam information as documented in the `powerplantmatching README <https://github.com/FRESNA/powerplantmatching/blob/master/README.md>`_; additionally it includes information on the closest substation/bus in ``networks/base.nc``.
.. image:: img/powerplantmatching.png
.. image:: ../img/powerplantmatching.png
:scale: 30 %
**Source:** `powerplantmatching on GitHub <https://github.com/FRESNA/powerplantmatching>`_

14
scripts/build_renewable_profiles.py
View File

@ -44,12 +44,12 @@ Inputs
- ``data/bundle/corine/g250_clc06_V18_5.tif``: `CORINE Land Cover (CLC) <https://land.copernicus.eu/pan-european/corine-land-cover>`_ inventory on `44 classes <https://wiki.openstreetmap.org/wiki/Corine_Land_Cover#Tagging>`_ of land use (e.g. forests, arable land, industrial, urban areas).
.. image:: img/corine.png
.. image:: ../img/corine.png
:scale: 33 %
- ``data/bundle/GEBCO_2014_2D.nc``: A `bathymetric <https://en.wikipedia.org/wiki/Bathymetry>`_ data set with a global terrain model for ocean and land at 15 arc-second intervals by the `General Bathymetric Chart of the Oceans (GEBCO) <https://www.gebco.net/data_and_products/gridded_bathymetry_data/>`_.
.. image:: img/gebco_2019_grid_image.jpg
.. image:: ../img/gebco_2019_grid_image.jpg
:scale: 50 %
**Source:** `GEBCO <https://www.gebco.net/data_and_products/images/gebco_2019_grid_image.jpg>`_
@ -89,27 +89,27 @@ Outputs
- **profile**
.. image:: img/profile_ts.png
.. image:: ../img/profile_ts.png
:scale: 33 %
- **p_nom_max**
.. image:: img/p_nom_max_hist.png
.. image:: ../img/p_nom_max_hist.png
:scale: 33 %
- **potential**
.. image:: img/potential_heatmap.png
.. image:: ../img/potential_heatmap.png
:scale: 33 %
- **average_distance**
.. image:: img/distance_hist.png
.. image:: ../img/distance_hist.png
:scale: 33 %
- **underwater_fraction**
.. image:: img/underwater_hist.png
.. image:: ../img/underwater_hist.png
:scale: 33 %
Description

14
scripts/build_shapes.py
View File

@ -17,17 +17,17 @@ Inputs
- ``data/bundle/naturalearth/ne_10m_admin_0_countries.shp``: World country shapes
.. image:: img/countries.png
.. image:: ../img/countries.png
:scale: 33 %
- ``data/bundle/eez/World_EEZ_v8_2014.shp``: World `exclusive economic zones <https://en.wikipedia.org/wiki/Exclusive_economic_zone>`_ (EEZ)
.. image:: img/eez.png
.. image:: ../img/eez.png
:scale: 33 %
- ``data/bundle/NUTS_2013_60M_SH/data/NUTS_RG_60M_2013.shp``: Europe NUTS3 regions
.. image:: img/nuts3.png
.. image:: ../img/nuts3.png
:scale: 33 %
- ``data/bundle/nama_10r_3popgdp.tsv.gz``: Average annual population by NUTS3 region (`eurostat <http://appsso.eurostat.ec.europa.eu/nui/show.do?dataset=nama_10r_3popgdp&lang=en>`_)
@ -40,22 +40,22 @@ Outputs
- ``resources/country_shapes.geojson``: country shapes out of country selection
.. image:: img/country_shapes.png
.. image:: ../img/country_shapes.png
:scale: 33 %
- ``resources/offshore_shapes.geojson``: EEZ shapes out of country selection
.. image:: img/offshore_shapes.png
.. image:: ../img/offshore_shapes.png
:scale: 33 %
- ``resources/europe_shape.geojson``: Shape of Europe including countries and EEZ
.. image:: img/europe_shape.png
.. image:: ../img/europe_shape.png
:scale: 33 %
- ``resources/nuts3_shapes.geojson``: NUTS3 shapes out of country selection including population and GDP data.
.. image:: img/nuts3_shapes.png
.. image:: ../img/nuts3_shapes.png
:scale: 33 %
Description

6
scripts/cluster_network.py
View File

@ -35,18 +35,18 @@ Outputs
- ``resources/regions_onshore_{network}_s{simpl}_{clusters}.geojson``:
.. image:: img/regions_onshore_elec_s_X.png
.. image:: ../img/regions_onshore_elec_s_X.png
:scale: 33 %
- ``resources/regions_offshore_{network}_s{simpl}_{clusters}.geojson``:
.. image:: img/regions_offshore_elec_s_X.png
.. image:: ../img/regions_offshore_elec_s_X.png
:scale: 33 %
- ``resources/clustermaps_{network}_s{simpl}_{clusters}.h5``: Mapping of buses and lines from ``networks/elec_s{simpl}.nc`` to ``networks/elec_s{simpl}_{clusters}.nc``; has keys ['/busmap', '/busmap_s', '/linemap', '/linemap_negative', '/linemap_positive']
- ``networks/{network}_s{simpl}_{clusters}.nc``:
.. image:: img/elec_s_X.png
.. image:: ../img/elec_s_X.png
:scale: 40 %
Description

6
scripts/simplify_network.py
View File

@ -50,18 +50,18 @@ Outputs
- ``resources/regions_onshore_{network}_s{simpl}.geojson``:
.. image:: img/regions_onshore_elec_s.png
.. image:: ../img/regions_onshore_elec_s.png
:scale: 33 %
- ``resources/regions_offshore_{network}_s{simpl}.geojson``:
.. image:: img/regions_offshore_elec_s .png
.. image:: ../img/regions_offshore_elec_s .png
:scale: 33 %
- ``resources/clustermaps_{network}_s{simpl}.h5``: Mapping of buses from ``networks/elec.nc`` to ``networks/elec_s{simpl}.nc``; has keys ['/busmap_s']
- ``networks/{network}_s{simpl}.nc``:
.. image:: img/elec_s.png
.. image:: ../img/elec_s.png
:scale: 33 %
Description

2
scripts/solve_network.py
View File

@ -41,7 +41,7 @@ Outputs
- ``results/networks/{network}_s{simpl}_{clusters}_l{ll}_{opts}.nc``: Solved PyPSA network including optimisation results
.. image:: img/results.png
.. image:: ../img/results.png
:scale: 40 %
Description