Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
# Do not abort other tests if only a single one fails
fail-fast: false
matrix:
python-version: ["3.10", "3.11"]
python-version: ["3.10", "3.11", "3.12"]

steps:
-
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ CLIMADA is divided into two parts (two repositories):
1. the core [climada_python](https://github.com/CLIMADA-project/climada_python) contains all the modules necessary for the probabilistic impact, the averted damage, uncertainty and forecast calculations. Data for hazard, exposures and impact functions can be obtained from the [data API](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_util_api_client.ipynb). [Litpop](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_entity_LitPop.ipynb) is included as demo Exposures module, and [Tropical cyclones](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_hazard_TropCyclone.ipynb) is included as a demo Hazard module.
2. the petals [climada_petals](https://github.com/CLIMADA-project/climada_petals) contains all the modules for generating data (e.g., TC_Surge, WildFire, OpenStreeMap, ...). Most development is done here. The petals builds-upon the core and does not work as a stand-alone.

It is recommend for new users to begin with the core (1) and the [tutorials](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial) therein.
For new users, we recommend to begin with the core (1) and the [tutorials](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial) therein.

This is the Python (3.10+) version of CLIMADA - please see [here](https://github.com/davidnbresch/climada) for backward compatibility with the MATLAB version.
This is the Python version of CLIMADA - please see [here](https://github.com/davidnbresch/climada) for backward compatibility with the MATLAB version.

## Getting started

Expand Down
31 changes: 18 additions & 13 deletions doc/guide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,29 @@ Prerequisites
Download the installer suitable for your system and follow the respective installation instructions.
We do **not** recommend using the ``conda`` command anymore, rather use ``mamba`` (see :ref:`conda-instead-of-mamba`).

.. note:: When mentioning the terms "terminal" or "command line" in the following, we are referring to the "Terminal" apps on macOS or Linux and the "Miniforge Prompt" on Windows.
.. _python-versions:

.. admonition:: Python Versions

CLIMADA is primarily tested against a **supported** Python version, but is allowed to run with others.
If you follow the installation instructions exactly, you will create an environment with the supported version.
Depending on your setup, you are free to choose another allowed version, but we recommend the supported one.

.. list-table::
:width: 60%

* - **Supported Version**
- ``3.11``
* - Allowed Versions
- ``3.10``, ``3.11``, ``3.12``

.. _install-choice:

Decide on Your Entry Level!
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. hint:: When mentioning the terms "terminal" or "command line" in the following, we are referring to the "Terminal" apps on macOS or Linux and the "Miniforge Prompt" on Windows.

Depening on your level of expertise, we provide two different approaches:

* If you have never worked with a command line, or if you just want to give CLIMADA a try, follow the :ref:`simple instructions <install-simple>`.
Expand Down Expand Up @@ -168,18 +184,7 @@ For advanced Python users or developers of CLIMADA, we recommed cloning the CLIM
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::

CLIMADA can be installed for different Python versions.
If you want to use a different version, replace the version specification in the command above with another allowed version.

.. list-table::
:width: 60%

* - **Supported Version**
- ``3.11``
* - Allowed Versions
- ``3.10``, ``3.11``
.. note:: You may choose any of the :ref:`allowed Python versions <python-versions>` from the list above.

#. Use the default environment specs in ``env_climada.yml`` to install all dependencies.
Then activate the environment:
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
"Topic :: Scientific/Engineering :: Mathematics",
],
keywords="climate adaptation",
python_requires=">=3.10,<3.12",
python_requires=">=3.10,<3.13",
install_requires=[
"bayesian-optimization<2.0",
"bottleneck",
Expand Down