From 72471e9d9928f3a066bd4a3124b8453838150f0b Mon Sep 17 00:00:00 2001 From: Fabian Neumann Date: Sat, 18 Mar 2023 13:24:05 +0100 Subject: [PATCH] add release notes for v0.8.0 --- CITATION.cff | 20 ++++++++++++-------- config.default.yaml | 2 +- doc/conf.py | 4 ++-- doc/release_notes.rst | 4 ++-- doc/tutorial.rst | 16 ++++++++-------- 5 files changed, 25 insertions(+), 21 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index f14890d6..712a02f3 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,20 +3,21 @@ # SPDX-License-Identifier: CC0-1.0 cff-version: 1.1.0 -message: "If you use this package, please cite the corresponding manuscript in Energy Strategy Reviews." -title: "PyPSA-Eur: An open optimisation model of the European transmission system" +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.7.0 +version: 0.8.0 license: MIT -journal: Energy Strategy Reviews -doi: 10.1016/j.esr.2018.08.012 authors: - - family-names: Hörsch - given-names: Jonas - orcid: https://orcid.org/0000-0001-9438-767X - family-names: Brown given-names: Tom orcid: https://orcid.org/0000-0001-5898-1911 + - family-names: Victoria + given-names: Marta + orcid: https://orcid.org/0000-0003-1665-1281 + - family-names: Zeyen + given-names: Elisabeth + orcid: https://orcid.org/0000-0002-7262-3296 - family-names: Hofmann given-names: Fabian orcid: https://orcid.org/0000-0002-6604-5450 @@ -32,3 +33,6 @@ authors: - family-names: Schlachtberger given-names: David orcid: https://orcid.org/0000-0002-8167-8213 + - family-names: Hörsch + given-names: Jonas + orcid: https://orcid.org/0000-0001-9438-767X diff --git a/config.default.yaml b/config.default.yaml index b8919ee8..1a8a8a9f 100755 --- a/config.default.yaml +++ b/config.default.yaml @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: CC0-1.0 -version: 0.7.0 +version: 0.8.0 tutorial: false logging: diff --git a/doc/conf.py b/doc/conf.py index 83831054..4b3978af 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -79,9 +79,9 @@ author = "Tom Brown (KIT, TUB, FIAS), Jonas Hoersch (KIT, FIAS), Fabian Hofmann # built documents. # # The short X.Y version. -version = "0.7" +version = "0.8" # The full version, including alpha/beta/rc tags. -release = "0.7.0" +release = "0.8.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/release_notes.rst b/doc/release_notes.rst index b75579d7..426ab9ef 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -13,11 +13,11 @@ Upcoming Release * new feature or bugfix -PyPSA-Eur 0.8.0 (17th March 2023) +PyPSA-Eur 0.8.0 (18th March 2023) ================================= .. note:: - This is the first release of PyPSA-Eur which incorporates its sector-coupled extension PyPSA-Eur-Sec (v0.7.1). + This is the first release of PyPSA-Eur which incorporates its sector-coupled extension PyPSA-Eur-Sec (v0.7.0). PyPSA-Eur can now directly be used for high-resolution energy system modelling with sector-coupling including industry, transport, buildings, biomass, and detailed carbon management. The PyPSA-Eur-Sec repository is now deprecated. diff --git a/doc/tutorial.rst b/doc/tutorial.rst index 254b58d6..b6f5311b 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -32,7 +32,7 @@ configuration, execute .. code:: bash :class: full-width - snakemake -call --configfile test/config.electricity.yaml results/networks/elec_s_6_ec_lcopt_Co2L-24H.nc + snakemake -call results/test-elec/networks/elec_s_6_ec_lcopt_Co2L-24H.nc --configfile test/config.electricity.yaml This configuration is set to download a reduced data set via the rules :mod:`retrieve_databundle`, :mod:`retrieve_natura_raster`, :mod:`retrieve_cutout`. @@ -115,7 +115,7 @@ clustered down to 6 buses and every 24 hours aggregated to one snapshot. The com .. code:: bash - snakemake -call --configfile test/config.electricity.yaml results/networks/elec_s_6_ec_lcopt_Co2L-24H.nc + snakemake -call results/test-elec/networks/elec_s_6_ec_lcopt_Co2L-24H.nc --configfile test/config.electricity.yaml orders ``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_Co2L-24H.nc``: @@ -276,18 +276,18 @@ You can produce any output file occurring in the ``Snakefile`` by running For example, you can explore the evolution of the PyPSA networks by running -#. ``snakemake -call --configfile test/config.electricity.yaml resources/networks/base.nc`` -#. ``snakemake -call --configfile test/config.electricity.yaml resources/networks/elec.nc`` -#. ``snakemake -call --configfile test/config.electricity.yaml resources/networks/elec_s.nc`` -#. ``snakemake -call --configfile test/config.electricity.yaml resources/networks/elec_s_6.nc`` -#. ``snakemake -call --configfile test/config.electricity.yaml resources/networks/elec_s_6_ec_lcopt_Co2L-24H.nc`` +#. ``snakemake resources/networks/base.nc -call --configfile test/config.electricity.yaml`` +#. ``snakemake resources/networks/elec.nc -call --configfile test/config.electricity.yaml`` +#. ``snakemake resources/networks/elec_s.nc -call --configfile test/config.electricity.yaml`` +#. ``snakemake resources/networks/elec_s_6.nc -call --configfile test/config.electricity.yaml`` +#. ``snakemake resources/networks/elec_s_6_ec_lcopt_Co2L-24H.nc -call --configfile test/config.electricity.yaml`` To run all combinations of wildcard values provided in the ``config.yaml`` under ``scenario:``, you can use the collection rule ``solve_elec_networks``. .. code:: bash - snakemake -call --configfile test/config.electricity.yaml solve_elec_networks + snakemake -call solve_elec_networks --configfile test/config.electricity.yaml If you now feel confident and want to tackle runs with larger temporal and spatial scope, clean-up the repository and after modifying the ``config.yaml`` file