Skip to content

Commit

Permalink
Release v0.6.0 (#1264)
Browse files Browse the repository at this point in the history
* Update release notes

* Add a clarification to the release guide

* Update the config versions

* Clarify the release guidance

* Restore minor changes

---------

Co-authored-by: Davide Fioriti <[email protected]>
  • Loading branch information
ekatef and davide-f authored Dec 24, 2024
1 parent e7dd650 commit e3fc578
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 11 deletions.
2 changes: 1 addition & 1 deletion config.default.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# SPDX-License-Identifier: CC0-1.0

version: 0.5.0
version: 0.6.0
tutorial: false

logging:
Expand Down
2 changes: 1 addition & 1 deletion config.tutorial.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# SPDX-License-Identifier: CC0-1.0

version: 0.5.0
version: 0.6.0
tutorial: true


Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
copyright = f"{datetime.datetime.today().year}, {author}"

# The full version, including alpha/beta/rc tags
release = "0.5.0"
release = "0.6.0"

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
Expand Down
14 changes: 11 additions & 3 deletions doc/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,21 @@ This part of documentation collects descriptive release notes to capture the mai

**New Features and Major Changes**


**Minor Changes and bug-fixing**


PyPSA-Earth 0.6.0
=================

**New Features and Major Changes (24th December 2024)**

* Include option in the config to allow for custom airport data `PR #1241 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/1241>`__

* Added Dev Containers and docker as an option to get started with pypsa-earth `PR #1228 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/1228>`__

* Add a list of PyPSA-Earth applications in academic and industrial projects `PR #1255 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/1255>`__


* Computational improvements of build_osm_network `PR #845 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/845>`__

* Boost computational performances of set_lines_ids with cKDTree by scipy `PR #806 <https://github.com/pypsa-meets-earth/pypsa-earth/pull/806>`__
Expand Down Expand Up @@ -537,13 +545,13 @@ Release Process

* Make sure thah pinned versions of the environments ``*-pinned.yaml`` in ``envs`` folder are up-to-date.

* Update version number in ``doc/conf.py`` and ``*config.*.yaml``.
* Update version number in ``doc/conf.py``, ``default.config.yaml``, ``tutorial.config.yaml`` and ``test/config.*.yaml``.

* Open, review and merge pull request for branch ``release-v0.x.x``.
Make sure to close issues and PRs or the release milestone with it (e.g. closes #X).
Run ``pre-commit run --all`` locally and fix any issues.

* Tag a release on Github via ``git tag v0.x.x``, ``git push``, ``git push --tags``. Include release notes in the tag message.
* Update and checkout your local `main` and tag a release with ``git tag v0.x.x``, ``git push``, ``git push --tags``. Include release notes in the tag message using Github UI.

* Upload code to `zenodo code repository <https://doi.org>`_ with `GPLv3 license <https://www.gnu.org/licenses/gpl-3.0.en.html>`_.

Expand Down
2 changes: 1 addition & 1 deletion test/config.custom.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: CC0-1.0

### CHANGES TO CONFIG.TUTORIAL.YAML ###
version: 0.5.0
version: 0.6.0

run:
name: "custom"
Expand Down
2 changes: 1 addition & 1 deletion test/config.landlock.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: CC0-1.0

### CHANGES TO CONFIG.TUTORIAL.YAML ###
version: 0.5.0
version: 0.6.0

countries: ["BW"]

Expand Down
2 changes: 1 addition & 1 deletion test/config.monte_carlo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# SPDX-License-Identifier: CC0-1.0

### CHANGES TO CONFIG.TUTORIAL.YAML ###
version: 0.5.0
version: 0.6.0

monte_carlo:
options:
Expand Down
2 changes: 1 addition & 1 deletion test/config.sector.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# SPDX-License-Identifier: AGPL-3.0-or-later

version: 0.5.0
version: 0.6.0
tutorial: true

run:
Expand Down
2 changes: 1 addition & 1 deletion test/config.test_myopic.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# SPDX-License-Identifier: AGPL-3.0-or-later

version: 0.5.0
version: 0.6.0
logging_level: INFO
tutorial: true

Expand Down

0 comments on commit e3fc578

Please sign in to comment.