documentation fixes

2022-06-30 09:01:49 +02:00 · 2022-06-30 09:01:49 +02:00 · 27e5dec4e6
commit 27e5dec4e6
parent 080075ec9f
7 changed files with 69 additions and 66 deletions
--- a/config.default.yaml
+++ b/config.default.yaml
@ -17,25 +17,6 @@ scenario:

 countries: ['AL', 'AT', 'BA', 'BE', 'BG', 'CH', 'CZ', 'DE', 'DK', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE', 'IT', 'LT', 'LU', 'LV', 'ME', 'MK', 'NL', 'NO', 'PL', 'PT', 'RO', 'RS', 'SE', 'SI', 'SK']

-clustering:
-  simplify_network:
-    to_substations: false # network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections)
-    algorithm: kmeans # choose from: [hac, kmeans]
-    feature: solar+onwind-time # only for hac. choose from: [solar+onwind-time, solar+onwind-cap, solar-time, solar-cap, solar+offwind-cap] etc.
-  cluster_network:
-    algorithm: kmeans
-    feature: solar+onwind-time
-  aggregation_strategies:
-    generators:
-      p_nom_max: sum # use "min" for more conservative assumptions
-      p_nom_min: sum
-      p_min_pu: mean
-      marginal_cost: mean
-      committable: any
-      ramp_limit_up: max
-      ramp_limit_down: max
-      efficiency: mean
-
 snapshots:
  start: "2013-01-01"
  end: "2014-01-01"
@ -251,6 +232,25 @@ costs:
  emission_prices: # in currency per tonne emission, only used with the option Ep
    co2: 0.

+clustering:
+  simplify_network:
+    to_substations: false # network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections)
+    algorithm: kmeans # choose from: [hac, kmeans]
+    feature: solar+onwind-time # only for hac. choose from: [solar+onwind-time, solar+onwind-cap, solar-time, solar-cap, solar+offwind-cap] etc.
+  cluster_network:
+    algorithm: kmeans
+    feature: solar+onwind-time
+  aggregation_strategies:
+    generators:
+      p_nom_max: sum # use "min" for more conservative assumptions
+      p_nom_min: sum
+      p_min_pu: mean
+      marginal_cost: mean
+      committable: any
+      ramp_limit_up: max
+      ramp_limit_down: max
+      efficiency: mean
+
 solving:
  options:
    formulation: kirchhoff
--- a/config.tutorial.yaml
+++ b/config.tutorial.yaml
@ -18,25 +18,6 @@ scenario:

 countries: ['BE']

-clustering:
-  simplify_network:
-    to_substations: false # network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections)
-    algorithm: kmeans # choose from: [hac, kmeans]
-    feature: solar+onwind-time # only for hac. choose from: [solar+onwind-time, solar+onwind-cap, solar-time, solar-cap, solar+offwind-cap] etc.
-  cluster_network:
-    algorithm: kmeans
-    feature: solar+onwind-time
-  aggregation_strategies:
-    generators:
-      p_nom_max: sum # use "min" for more conservative assumptions
-      p_nom_min: sum
-      p_min_pu: mean
-      marginal_cost: mean
-      committable: any
-      ramp_limit_up: max
-      ramp_limit_down: max
-      efficiency: mean
-
 snapshots:
  start: "2013-03-01"
  end: "2013-04-01"
@ -184,6 +165,25 @@ costs:
  emission_prices: # in currency per tonne emission, only used with the option Ep
    co2: 0.

+clustering:
+  simplify_network:
+    to_substations: false # network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections)
+    algorithm: kmeans # choose from: [hac, kmeans]
+    feature: solar+onwind-time # only for hac. choose from: [solar+onwind-time, solar+onwind-cap, solar-time, solar-cap, solar+offwind-cap] etc.
+  cluster_network:
+    algorithm: kmeans
+    feature: solar+onwind-time
+  aggregation_strategies:
+    generators:
+      p_nom_max: sum # use "min" for more conservative assumptions
+      p_nom_min: sum
+      p_min_pu: mean
+      marginal_cost: mean
+      committable: any
+      ramp_limit_up: max
+      ramp_limit_down: max
+      efficiency: mean
+
 solving:
  options:
    formulation: kirchhoff
--- a/doc/configtables/snapshots.csv
+++ b/doc/configtables/snapshots.csv
@ -1,4 +1,4 @@
 ,Unit,Values,Description
 start,--,"str or datetime-like; e.g. YYYY-MM-DD","Left bound of date range"
 end,--,"str or datetime-like; e.g. YYYY-MM-DD","Right bound of date range"
-closed,--,"One of {None, ‘left’, ‘right’}","Make the time interval closed to the ``left``, ``right``, or both sides ``None``."
+closed,--,"One of {None, ‘left’, ‘right’}","Make the time interval closed to the ``left``, ``right``, or open on both sides ``None``."
--- a/doc/installation.rst
+++ b/doc/installation.rst
@ -102,6 +102,8 @@ It might be the case that you can only retrieve solutions by using a commercial
        conda activate pypsa-eur
        conda install -c conda-forge ipopt glpk

+.. warning::
+    On Windows, new versions of ``ipopt`` have caused problems. Consider downgrading to version 3.11.1.

 .. _defaultconfig:

--- a/doc/tutorial.rst
+++ b/doc/tutorial.rst
@ -47,7 +47,8 @@ The model can be adapted to only include selected countries (e.g. Belgium) inste

 .. literalinclude:: ../config.tutorial.yaml
   :language: yaml
-   :lines: 20
+   :start-at: countries:
+   :end-before: snapshots:

 Likewise, the example's temporal scope can be restricted (e.g. to a single month).

@ -60,14 +61,14 @@ It is also possible to allow less or more carbon-dioxide emissions. Here, we lim

 .. literalinclude:: ../config.tutorial.yaml
   :language: yaml
-   :lines: 40,42
+   :lines: 35,37

 PyPSA-Eur also includes a database of existing conventional powerplants.
-We can select which types of powerplants we like to be included with fixed capacities:
+We can select which types of powerplants we like to be included:

 .. literalinclude:: ../config.tutorial.yaml
   :language: yaml
-   :lines: 40,56
+   :lines: 35,51

 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.
@ -82,14 +83,14 @@ For example, we may want to use the ERA-5 dataset for solar and not the default

 .. literalinclude:: ../config.tutorial.yaml
   :language: yaml
-   :lines: 67,110,111
+   :lines: 62,105,106

 Finally, it is possible to pick a solver. For instance, this tutorial uses the open-source solvers CBC and Ipopt and does not rely
 on the commercial solvers Gurobi or CPLEX (for which free academic licenses are available).

 .. literalinclude:: ../config.tutorial.yaml
   :language: yaml
-   :lines: 173,183,184
+   :lines: 187,197,198

 .. note::

@ -284,4 +285,4 @@ The solved networks can be analysed just like any other PyPSA network (e.g. in J

    network = pypsa.Network("results/networks/elec_s_6_ec_lcopt_Co2L-24H.nc")

-For inspiration, read the `examples section in the PyPSA documentation <https://pypsa.readthedocs.io/en/latest/examples.html>`_.
+For inspiration, read the `examples section in the PyPSA documentation <https://pypsa.readthedocs.io/en/latest/examples-basic.html>`_.
--- a/scripts/retrieve_databundle.py
+++ b/scripts/retrieve_databundle.py
@ -11,7 +11,7 @@ The data bundle (1.4 GB) contains common GIS datasets like NUTS3 shapes, EEZ sha

 This rule downloads the data bundle from `zenodo <https://doi.org/10.5281/zenodo.3517935>`_ and extracts it in the ``data`` sub-directory, such that all files of the bundle are stored in the ``data/bundle`` subdirectory.

-The :ref:`tutorial` uses a smaller `data bundle <https://zenodo.org/record/3517921/files/pypsa-eur-tutorial-data-bundle.tar.xz>`_ than required for the full model (19 MB)
+The :ref:`tutorial` uses a smaller `data bundle <https://zenodo.org/record/3517921/files/pypsa-eur-tutorial-data-bundle.tar.xz>`_ than required for the full model (188 MB)

 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3517921.svg
    :target: https://doi.org/10.5281/zenodo.3517921
--- a/test/config.test1.yaml
+++ b/test/config.test1.yaml
@ -17,25 +17,6 @@ scenario:

 countries: ['BE']

-clustering:
-  simplify_network:
-    to_substations: false # network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections)
-    algorithm: kmeans # choose from: [hac, kmeans]
-    feature: solar+onwind-time # only for hac. choose from: [solar+onwind-time, solar+onwind-cap, solar-time, solar-cap, solar+offwind-cap] etc.
-  cluster_network:
-    algorithm: kmeans
-    feature: solar+onwind-time
-  aggregation_strategies:
-    generators:
-      p_nom_max: sum # use "min" for more conservative assumptions
-      p_nom_min: sum
-      p_min_pu: mean
-      marginal_cost: mean
-      committable: any
-      ramp_limit_up: max
-      ramp_limit_down: max
-      efficiency: mean
-
 snapshots:
  start: "2013-03-01"
  end: "2013-03-08"
@ -182,6 +163,25 @@ costs:
  emission_prices: # only used with the option Ep
    co2: 0.

+clustering:
+  simplify_network:
+    to_substations: false # network is simplified to nodes with positive or negative power injection (i.e. substations or offwind connections)
+    algorithm: kmeans # choose from: [hac, kmeans]
+    feature: solar+onwind-time # only for hac. choose from: [solar+onwind-time, solar+onwind-cap, solar-time, solar-cap, solar+offwind-cap] etc.
+  cluster_network:
+    algorithm: kmeans
+    feature: solar+onwind-time
+  aggregation_strategies:
+    generators:
+      p_nom_max: sum # use "min" for more conservative assumptions
+      p_nom_min: sum
+      p_min_pu: mean
+      marginal_cost: mean
+      committable: any
+      ramp_limit_up: max
+      ramp_limit_down: max
+      efficiency: mean
+
 solving:
  options:
    formulation: kirchhoff