From edc092ad3ac84815cfa34ecbf7b4e6b4f1077a21 Mon Sep 17 00:00:00 2001 From: Lukas Riedel <34276446+peanutfun@users.noreply.github.com> Date: Fri, 21 Jun 2024 11:00:34 +0200 Subject: [PATCH 1/3] Allow downgrading of Python bugfix version Adjust install guide accordingly. --- doc/guide/install.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/guide/install.rst b/doc/guide/install.rst index 43a977372a..c30fefd055 100644 --- a/doc/guide/install.rst +++ b/doc/guide/install.rst @@ -161,7 +161,12 @@ For advanced Python users or developers of CLIMADA, we recommed cloning the CLIM .. code-block:: shell - mamba create -n climada_env python=3.9 + mamba create -n climada_env "python=3.9.*" + + .. hint:: + + Use the wildcard ``.*`` at the end to allow a downgrade of the bugfix version of Python. + This increases compatibility when installing the requirements in the next step. .. note:: From e89a5b6571dfbd73ac951c3e3ea61601dd4dc17c Mon Sep 17 00:00:00 2001 From: Lukas Riedel <34276446+peanutfun@users.noreply.github.com> Date: Fri, 21 Jun 2024 11:01:11 +0200 Subject: [PATCH 2/3] Fix links in CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d465d7e5e..f21b73e951 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Please contact the [lead developers](https://wcr.ethz.ch/research/climada.html) ## Minimal Steps to Contribute -Before you start, please have a look at our [Developer Guide][devguide]. +Before you start, please have a look at our Developer Guide section in the [CLIMADA Docs][docs]. To contribute follow these steps: @@ -65,21 +65,22 @@ To contribute follow these steps: ## Resources -The CLIMADA documentation provides a [Developer Guide][devguide]. +The [CLIMADA documentation][docs] provides several Developer Guides. Here's a selection of the commonly required information: * How to use Git and GitHub for CLIMADA development: [Development and Git and CLIMADA](https://climada-python.readthedocs.io/en/latest/guide/Guide_Git_Development.html) -* Coding instructions for CLIMADA: [Python Dos and Don'ts](https://climada-python.readthedocs.io/en/latest/guide/Guide_PythonDos-n-Donts.html), [Performance Tips](https://climada-python.readthedocs.io/en/latest/guide/Guide_Py_Performance.html), [CLIMADA Conventions](https://climada-python.readthedocs.io/en/latest/guide/Guide_Miscellaneous.html) -* How to execute tests in CLIMADA: [Testing and Continuous Integration][testing] +* Coding instructions for CLIMADA: [Python Dos and Don'ts](https://climada-python.readthedocs.io/en/latest/guide/Guide_PythonDos-n-Donts.html), [Performance Tips](https://climada-python.readthedocs.io/en/latest/guide/Guide_Py_Performance.html), [CLIMADA Conventions](https://climada-python.readthedocs.io/en/latest/guide/Guide_CLIMADA_conventions.html) +* How to execute tests in CLIMADA: [Testing][testing] and [Continuous Integration](https://climada-python.readthedocs.io/en/latest/guide/Guide_continuous_integration_GitHub_actions.html) ## Pull Requests After developing a new feature, fixing a bug, or updating the tutorials, you can create a [pull request](https://docs.github.com/en/pull-requests) to have your changes reviewed and then merged into the CLIMADA code base. To ensure that your pull request can be reviewed quickly and easily, please have a look at the _Resources_ above before opening a pull request. -In particular, please check out the [Pull Request instructions](https://climada-python.readthedocs.io/en/latest/guide/Guide_Git_Development.html#Pull-requests). +In particular, please check out the [Pull Request instructions](https://climada-python.readthedocs.io/en/latest/guide/Guide_Git_Development.html#pull-requests). We provide a description template for pull requests that helps you provide the essential information for reviewers. It also contains a checklist for both pull request authors and reviewers to guide the review process. +[docs]: https://climada-python.readthedocs.io/en/latest/ [devguide]: https://climada-python.readthedocs.io/en/latest/#developer-guide -[testing]: https://climada-python.readthedocs.io/en/latest/guide/Guide_Continuous_Integration_and_Testing.html +[testing]: https://climada-python.readthedocs.io/en/latest/guide/Guide_Testing.html From 6cd12372e9ef8fa660a1c7a6b05b199361f9b95a Mon Sep 17 00:00:00 2001 From: Lukas Riedel <34276446+peanutfun@users.noreply.github.com> Date: Fri, 21 Jun 2024 11:07:33 +0200 Subject: [PATCH 3/3] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 78543cf491..f0620a813f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,6 +27,8 @@ CLIMADA tutorials. [#872](https://github.com/CLIMADA-project/climada_python/pull ### Fixed - Avoid an issue where a Hazard subselection would have a fraction matrix with only zeros as entries by throwing an error [#866](https://github.com/CLIMADA-project/climada_python/pull/866) +- Allow downgrading the Python bugfix version to improve environment compatibility [#900](https://github.com/CLIMADA-project/climada_python/pull/900) +- Fix broken links in `CONTRIBUTING.md` [#900](https://github.com/CLIMADA-project/climada_python/pull/900) ### Added