Merge pull request #705 from PyPSA/release-v0.8.1

Prepare release v0.8.1

CITATION.cff

@@ -6,7 +6,7 @@ cff-version: 1.1.0
 message: "If you use this package, please cite it in the following way."
 title: "PyPSA-Eur: An open sector-coupled optimisation model of the European energy system"
 repository: https://github.com/pypsa/pypsa-eur
-version: 0.8.0
+version: 0.8.1
 license: MIT
 authors:
   - family-names: Brown

README.md

@@ -9,7 +9,7 @@ SPDX-License-Identifier: CC-BY-4.0
 ![Size](https://img.shields.io/github/repo-size/pypsa/pypsa-eur)
 [![Zenodo PyPSA-Eur](https://zenodo.org/badge/DOI/10.5281/zenodo.3520874.svg)](https://doi.org/10.5281/zenodo.3520874)
 [![Zenodo PyPSA-Eur-Sec](https://zenodo.org/badge/DOI/10.5281/zenodo.3938042.svg)](https://doi.org/10.5281/zenodo.3938042)
-[![Snakemake](https://img.shields.io/badge/snakemake-≥5.0.0-brightgreen.svg?style=flat)](https://snakemake.readthedocs.io)
+[![Snakemake](https://img.shields.io/badge/snakemake-≥7.7.0-brightgreen.svg?style=flat)](https://snakemake.readthedocs.io)
 [![REUSE status](https://api.reuse.software/badge/github.com/pypsa/pypsa-eur)](https://api.reuse.software/info/github.com/pypsa/pypsa-eur)
 [![Stack Exchange questions](https://img.shields.io/stackexchange/stackoverflow/t/pypsa)](https://stackoverflow.com/questions/tagged/pypsa)
 
@@ -35,17 +35,18 @@ The model is designed to be imported into the open toolbox
 [PyPSA](https://github.com/PyPSA/PyPSA).
 
 **WARNING**: PyPSA-Eur is under active development and has several
-[limitations](https://pypsa-eur.readthedocs.io/en/latest/limitations.html)
-which you should understand before using the model. The github repository
+[limitations](https://pypsa-eur.readthedocs.io/en/latest/limitations.html) which
+you should understand before using the model. The github repository
 [issues](https://github.com/PyPSA/pypsa-eur/issues) collect known topics we are
 working on (please feel free to help or make suggestions). The
 [documentation](https://pypsa-eur.readthedocs.io/) remains somewhat patchy. You
-can find showcases of the model's capabilities in the preprint [Benefits of a
-Hydrogen Network in Europe](https://arxiv.org/abs/2207.05816), a [paper in Joule
-with a description of the industry sector](https://arxiv.org/abs/2109.09563), or
-in [a 2021 presentation at EMP-E](https://nworbmot.org/energy/brown-empe.pdf).
-We cannot support this model if you choose to use it. We do not recommend to use
-the full resolution network model for simulations. At high granularity the
+can find showcases of the model's capabilities in the Joule paper [The potential
+role of a hydrogen network in
+Europe](https://doi.org/10.1016/j.joule.2023.06.016), another [paper in Joule
+with a description of the industry
+sector](https://doi.org/10.1016/j.joule.2022.04.016), or in [a 2021 presentation
+at EMP-E](https://nworbmot.org/energy/brown-empe.pdf). We do not recommend to
+use the full resolution network model for simulations. At high granularity the
 assignment of loads and generators to the nearest network node may not be a
 correct assumption, depending on the topology of the underlying distribution
 grid, and local grid bottlenecks may cause unrealistic load-shedding or

config/config.default.yaml

@@ -3,7 +3,7 @@
 # SPDX-License-Identifier: CC0-1.0
 
 # docs in https://pypsa-eur.readthedocs.io/en/latest/configuration.html#top-level-configuration
-version: 0.8.0
+version: 0.8.1
 tutorial: false
 
 logging:

config/test/config.myopic.yaml

@@ -62,11 +62,6 @@ renewable:
   solar:
     cutout: be-03-2013-era5
 
-lines:
-  dynamic_line_rating:
-    activate: true
-    max_line_rating: 1.3
-
 industry:
   St_primary_fraction:
     2030: 0.6

config/test/config.overnight.yaml

@@ -59,11 +59,6 @@ renewable:
   solar:
     cutout: be-03-2013-era5
 
-lines:
-  dynamic_line_rating:
-    activate: true
-    max_line_rating: 1.3
-
 sector:
   gas_network: true
   H2_retrofit: true

doc/conf.py

@@ -82,7 +82,7 @@
 # The short X.Y version.
 version = "0.8"
 # The full version, including alpha/beta/rc tags.
-release = "0.8.0"
+release = "0.8.1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/index.rst

@@ -78,10 +78,10 @@ them:
 
 .. note::
     You can find showcases of the model's capabilities in the Supplementary Materials of the
-    preprint `Benefits of a Hydrogen Network in Europe
-    <https://arxiv.org/abs/2207.05816>`_, the Supplementary Materials of the `paper in Joule with a
+    Joule paper `The potential role of a hydrogen network in Europe
+    <https://doi.org/10.1016/j.joule.2023.06.016>`_, the Supplementary Materials of another `paper in Joule with a
     description of the industry sector
-    <https://arxiv.org/abs/2109.09563>`_, or in `a 2021 presentation
+    <https://doi.org/10.1016/j.joule.2022.04.016>`_, or in `a 2021 presentation
     at EMP-E <https://nworbmot.org/energy/brown-empe.pdf>`_.
     The sector-coupled extension of PyPSA-Eur was
     initially described in the paper `Synergies of sector coupling and transmission
@@ -179,10 +179,13 @@ For sector-coupling studies: ::
 
     @misc{PyPSAEurSec,
         author = "Fabian Neumann and Elisabeth Zeyen and Marta Victoria and Tom Brown",
-        title = "The Potential Role of a Hydrogen Network in Europe",
-        year = "2022",
+        title = "The potential role of a hydrogen network in Europe",
+        journal "Joule",
+        volume = "7",
+        pages = "1--25"
+        year = "2023",
         eprint = "2207.05816",
-        url = "https://arxiv.org/abs/2207.05816",
+        doi = "10.1016/j.joule.2022.04.016",
     }
 
 For sector-coupling studies with pathway optimisation: ::

doc/release_notes.rst

@@ -7,46 +7,130 @@
 Release Notes
 ##########################################
 
-Upcoming Release
-================
+.. Upcoming Release
+.. ================
 
-* ``param:`` section in rule definition are added to track changed settings in ``config.yaml``. The goal is to automatically re-execute rules whose parameters have changed. See `Non-file parameters for rules <https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#non-file-parameters-for-rules>`_ in the snakemake documentation.
+PyPSA-Eur 0.8.1 (27th July 2023)
+================================
 
-* **Important:** The configuration files are now located in the ``config`` directory. This counts for ``config.default.yaml``, ``config.yaml`` as well as the test configuration files which are now located in ``config/test``. Config files that are still in the root directory will be ignored.
-
-* Bugfix: Correct typo in the CPLEX solver configuration in ``config.default.yaml``.
-
-* Bugfix: Error in ``add_electricity`` where carriers were added multiple times to the network, resulting in a non-unique carriers error.
+**New Features**
 
-* Renamed script file from PyPSA-EUR ``build_load_data`` to ``build_electricity_demand`` and ``retrieve_load_data`` to ``retrieve_electricity_demand``.
+* Add option to consider dynamic line rating based on wind speeds and
+  temperature according to `Glaum and Hofmann (2022)
+  <https://arxiv.org/abs/2208.04716>`_. See configuration section ``lines:
+  dynamic_line_rating:`` for more details. (https://github.com/PyPSA/pypsa-eur/pull/675)
 
-* Fix docs readthedocs built
+* Add option to include a piecewise linear approximation of transmission losses,
+  e.g. by setting ``solving: options: transmission_losses: 2`` for an
+  approximation with two tangents. (https://github.com/PyPSA/pypsa-eur/pull/664)
 
 * Add plain hydrogen turbine as additional re-electrification option besides
   hydrogen fuel cell. Add switches for both re-electrification options under
   ``sector: hydrogen_turbine:`` and ``sector: hydrogen_fuel_cell:``.
+  (https://github.com/PyPSA/pypsa-eur/pull/647)
 
-* A new function named ``sanitize_carrier`` ensures that all unique carrier names are present in the network's carriers attribute, and adds nice names and colors for each carrier according to the provided configuration dictionary.
+* Added configuration option ``lines: max_extension:`` and ``links:
+  max_extension:``` to control the maximum capacity addition per line or link in
+  MW. (https://github.com/PyPSA/pypsa-eur/pull/665)
 
-* Additional tech_color are added to include previously unlisted carriers.
+* A ``param:`` section in the snakemake rule definitions was added to track
+  changed settings in ``config.yaml``. The goal is to automatically re-execute
+  rules where parameters have changed. See `Non-file parameters for rules
+  <https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#non-file-parameters-for-rules>`_
+  in the snakemake documentation. (https://github.com/PyPSA/pypsa-eur/pull/663)
 
-* Remove ``vresutils`` dependency.
+* A new function named ``sanitize_carrier`` ensures that all unique carrier
+  names are present in the network's carriers attribute, and adds nice names and
+  colors for each carrier according to the provided configuration dictionary.
+  (https://github.com/PyPSA/pypsa-eur/pull/653,
+  https://github.com/PyPSA/pypsa-eur/pull/690)
 
-* Added configuration option ``lines: max_extension:`` and ``links:
-  max_extension:``` to control the maximum capacity addition per line or link in
-  MW.
+* The configuration settings have been documented in more detail.
+  (https://github.com/PyPSA/pypsa-eur/pull/685)
 
-* Add option to include a piecewise linear approximation of transmission losses,
-  e.g. by setting ``solving: options: transmission_losses: 2`` for an
-  approximation with two tangents.
+**Breaking Changes**
+
+* The configuration files are now located in the ``config`` directory. This
+  includes the ``config.default.yaml``, ``config.yaml`` as well as the test
+  configuration files which are now located in the ``config/test`` directory.
+  Config files that are still in the root directory will be ignored.
+  (https://github.com/PyPSA/pypsa-eur/pull/640)
+
+* Renamed script and rule name from ``build_load_data`` to
+  ``build_electricity_demand`` and ``retrieve_load_data`` to
+  ``retrieve_electricity_demand``. (https://github.com/PyPSA/pypsa-eur/pull/642,
+  https://github.com/PyPSA/pypsa-eur/pull/652)
+
+* Updated to new spatial clustering module introduced in PyPSA v0.25.
+  (https://github.com/PyPSA/pypsa-eur/pull/696)
+
+**Changes**
 
 * Handling networks with links with multiple inputs/outputs no longer requires
   to override component attributes.
+  (https://github.com/PyPSA/pypsa-eur/pull/695)
 
 * Added configuration option ``enable: retrieve:`` to control whether data
   retrieval rules from snakemake are enabled or not. Th default setting ``auto``
-  will automatically detect and enable/disable the rules based on internet connectivity.
+  will automatically detect and enable/disable the rules based on internet
+  connectivity. (https://github.com/PyPSA/pypsa-eur/pull/694)
+
+* Update to ``technology-data`` v0.6.0.
+  (https://github.com/PyPSA/pypsa-eur/pull/704)
+
+* Handle data bundle extraction paths via ``snakemake.output``.
+
+* Additional technologies are added to ``tech_color`` in the configuration files
+  to include previously unlisted carriers.
+
+* Doc: Added note that Windows is only tested in CI with WSL.
+  (https://github.com/PyPSA/pypsa-eur/issues/697)
+
+* Doc: Add support section. (https://github.com/PyPSA/pypsa-eur/pull/656)
+
+* Open ``rasterio`` files with ``rioxarray``.
+  (https://github.com/PyPSA/pypsa-eur/pull/474)
+
+* Migrate CI to ``micromamba``. (https://github.com/PyPSA/pypsa-eur/pull/700)
+
+**Bugs and Compatibility**
+
+* The new minimum PyPSA version is v0.25.1.
+
+* Removed ``vresutils`` dependency.
+  (https://github.com/PyPSA/pypsa-eur/pull/662)
+
+* Adapt to new ``powerplantmatching`` version.
+  (https://github.com/PyPSA/pypsa-eur/pull/687,
+  https://github.com/PyPSA/pypsa-eur/pull/701)
+
+* Bugfix: Correct typo in the CPLEX solver configuration in
+  ``config.default.yaml``. (https://github.com/PyPSA/pypsa-eur/pull/630)
+
+* Bugfix: Error in ``add_electricity`` where carriers were added multiple times
+  to the network, resulting in a non-unique carriers error.
+
+* Bugfix of optional reserve constraint.
+  (https://github.com/PyPSA/pypsa-eur/pull/645)
+
+* Fix broken equity constraints logic.
+  (https://github.com/PyPSA/pypsa-eur/pull/679)
+
+* Fix addition of load shedding generators.
+  (https://github.com/PyPSA/pypsa-eur/pull/649)
+
+* Fix automatic building of documentation on readthedocs.org.
+  (https://github.com/PyPSA/pypsa-eur/pull/658)
+
+* Bugfix: Update network clustering to avoid adding deleted links in clustered
+  network. (https://github.com/PyPSA/pypsa-eur/pull/678)
+
+* Address ``geopandas`` deprecations.
+  (https://github.com/PyPSA/pypsa-eur/pull/678)
 
+* Fix bug with underground hydrogen storage creation, where for some small model
+  regions no cavern storage is available.
+  (https://github.com/PyPSA/pypsa-eur/pull/672)
 
 
 PyPSA-Eur 0.8.0 (18th March 2023)