Merge branch 'develop' into feature/update_unsequa_tuto

Author: luseverin

.github/pull_request_template.md

@@ -19,10 +19,10 @@ This PR fixes #
 ### PR Reviewer Checklist
 
 - [ ] Read the [Contribution Guide][contrib]
-- [ ] [CLIMADA Reviewer Checklist](https://climada-python.readthedocs.io/en/latest/guide/Guide_Reviewer_Checklist.html) passed
+- [ ] [CLIMADA Reviewer Checklist](https://climada-python.readthedocs.io/en/latest/development/Guide_Review.html) passed
 - [ ] [Tests][testing] passing
 - [ ] No new [linter issues][linter]
 
 [contrib]: https://github.com/CLIMADA-project/climada_python/blob/main/CONTRIBUTING.md
-[testing]: https://climada-python.readthedocs.io/en/latest/guide/Guide_Continuous_Integration_and_Testing.html
-[linter]: https://climada-python.readthedocs.io/en/stable/guide/Guide_Continuous_Integration_and_Testing.html#3.C.--Static-Code-Analysis
+[testing]: https://climada-python.readthedocs.io/en/latest/development/Guide_continuous_integration_GitHub_actions.html
+[linter]: https://climada-python.readthedocs.io/en/latest/development/Guide_continuous_integration_GitHub_actions.html#static-code-analysis

.github/scripts/prepare_release.py

@@ -3,7 +3,7 @@
 
 The following preparation steps are executed:
 
-- update version numbers in _version.py and setup.py
+- update version numbers in _version.py and pyproject.toml
 - purge the "Unreleased" section of CHANGELOG.md and rename it to the new version number
 
 All changes are immediately commited to the repository.
@@ -117,10 +117,10 @@ def update_version(nvn):
     return update_file(file_with_version, regex, nvn)
 
 
-def update_setup(new_version_number):
-    """Update the setup.py file"""
-    file_with_version = "setup.py"
-    regex = r"(^\s+version\s*=\s*[\'\"]).*([\'\"]\s*,\s*$)"
+def update_pyproject(new_version_number):
+    """Update the pyproject.toml file"""
+    file_with_version = "pyproject.toml"
+    regex = r"(^version\s*=\s*[\'\"]).*([\'\"]\s*$)"
     return update_file(file_with_version, regex, new_version_number)
 
 
@@ -211,7 +211,7 @@ def prepare_new_release(level):
             raise
     new_version_number = bump_version_number(last_version_number, level)
 
-    update_setup(new_version_number).gitadd()
+    update_pyproject(new_version_number).gitadd()
     update_version(new_version_number).gitadd()
     update_changelog(new_version_number).gitadd()
 

.github/scripts/setup_devbranch.py

@@ -3,7 +3,7 @@
 
 The following preparation steps are executed:
 
-- update version numbers in _version.py and setup.py: append a -dev suffix
+- update version numbers in _version.py and pyproject.toml: append a -dev suffix
 - insert a vanilla "unreleased" section on top of CHANGELOG.md
 
 The changes are not commited to the repository. This is dealt with in the bash script
@@ -75,10 +75,10 @@ def update_version(nvn):
     return update_file(file_with_version, regex, nvn)
 
 
-def update_setup(new_version_number):
-    """Update the setup.py file"""
-    file_with_version = "setup.py"
-    regex = r"(^\s+version\s*=\s*[\'\"]).*([\'\"]\s*,\s*$)"
+def update_pyproject(new_version_number):
+    """Update the pyproject.toml file"""
+    file_with_version = "pyproject.toml"
+    regex = r"(^version\s*=\s*[\'\"]).*([\'\"]\s*$)"
     return update_file(file_with_version, regex, new_version_number)
 
 
@@ -110,7 +110,7 @@ def setup_devbranch():
     semver[-1] = f"{int(semver[-1]) + 1}-dev"
     dev_version = ".".join(semver)
 
-    update_setup(dev_version)
+    update_pyproject(dev_version)
     update_version(dev_version)
     update_changelog()
 

.github/scripts/setup_devbranch.sh

@@ -10,14 +10,14 @@ git checkout develop
 git pull
 
 git checkout origin/main \
-    setup.py \
+    pyproject.toml \
     CHANGELOG.md \
     */_version.py
 
 release=`python .github/scripts/setup_devbranch.py`
 
 git add \
-    setup.py \
+    pyproject.toml \
     CHANGELOG.md \
     */_version.py
 

.github/workflows/ci.yml

@@ -47,7 +47,7 @@ jobs:
       -
         name: Install CLIMADA
         run: |
-          python -m pip install ".[test]"
+          python -m pip install "./[dev]"
       -
         name: Run Unit Tests
         run: |

.github/workflows/make-release.yml

@@ -1,7 +1,7 @@
 # This workflow will create a new release from main
 
 # the new version number is the old one increased by 1 in the given level [major, minor, patch]
-# first, some files are modified (_version.py, setup.py and CHANGELOG.md
+# first, some files are modified (_version.py, pyproject.toml and CHANGELOG.md
 # then, a new release is created on GitHub, tagged with v[new version number]
 
 name: Create a new release

.github/workflows/postrelease-setup-devbranch.yml

@@ -1,6 +1,6 @@
 # This workflow will re-initialize the develop branch after a release was published
 
-# the version number of setup.py and _version.py will be taken from main, but have a "-dev" appendix
+# the version number of pyproject.toml and _version.py will be taken from main, but have a "-dev" appendix
 # the CHANGELOG.md file will be updated and have a vanila "Unreleased" section
 
 name: Post-release develop setup

.readthedocs.yml

@@ -25,6 +25,3 @@ python:
 
 formats:
   - pdf
-
-sphinx:
-  configuration: doc/conf.py

.zenodo.json

@@ -119,6 +119,9 @@
     },
     {
       "name": "Valentin Gebhart"
+    },
+    {
+      "name": "Dahyann Araya"
     }
   ]
 }

AUTHORS.md

@@ -36,3 +36,4 @@
 * Luca Severino
 * Samuel Juhel
 * Valentin Gebhart
+* Dahyann Araya