You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,9 @@ CLIMADA is divided into two parts (two repositories):
16
16
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.
17
17
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.
18
18
19
-
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.
19
+
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.
20
20
21
-
This is the Python (3.10+) version of CLIMADA - please see [here](https://github.com/davidnbresch/climada) for backward compatibility with the MATLAB version.
21
+
This is the Python version of CLIMADA - please see [here](https://github.com/davidnbresch/climada) for backward compatibility with the MATLAB version.
Copy file name to clipboardExpand all lines: doc/guide/install.rst
+18-13Lines changed: 18 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,13 +29,29 @@ Prerequisites
29
29
Download the installer suitable for your system and follow the respective installation instructions.
30
30
We do **not** recommend using the ``conda`` command anymore, rather use ``mamba`` (see :ref:`conda-instead-of-mamba`).
31
31
32
-
.. 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.
32
+
.. _python-versions:
33
+
34
+
.. admonition:: Python Versions
35
+
36
+
CLIMADA is primarily tested against a **supported** Python version, but is allowed to run with others.
37
+
If you follow the installation instructions exactly, you will create an environment with the supported version.
38
+
Depending on your setup, you are free to choose another allowed version, but we recommend the supported one.
39
+
40
+
.. list-table::
41
+
:width: 60%
42
+
43
+
* - **Supported Version**
44
+
- ``3.11``
45
+
* - Allowed Versions
46
+
- ``3.10``, ``3.11``, ``3.12``
33
47
34
48
.. _install-choice:
35
49
36
50
Decide on Your Entry Level!
37
51
^^^^^^^^^^^^^^^^^^^^^^^^^^^
38
52
53
+
.. 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.
54
+
39
55
Depening on your level of expertise, we provide two different approaches:
40
56
41
57
* 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>`.
@@ -168,18 +184,7 @@ For advanced Python users or developers of CLIMADA, we recommed cloning the CLIM
168
184
Use the wildcard ``.*`` at the end to allow a downgrade of the bugfix version of Python.
169
185
This increases compatibility when installing the requirements in the next step.
170
186
171
-
.. note::
172
-
173
-
CLIMADA can be installed for different Python versions.
174
-
If you want to use a different version, replace the version specification in the command above with another allowed version.
175
-
176
-
.. list-table::
177
-
:width: 60%
178
-
179
-
* - **Supported Version**
180
-
- ``3.11``
181
-
* - Allowed Versions
182
-
- ``3.10``, ``3.11``
187
+
.. note:: You may choose any of the :ref:`allowed Python versions <python-versions>` from the list above.
183
188
184
189
#. Use the default environment specs in ``env_climada.yml`` to install all dependencies.
0 commit comments