Skip to content

Commit 645862a

Browse files
committed
Merge branch 'develop' into calibrate-impact-functions
2 parents c40b85a + 12c3190 commit 645862a

File tree

3 files changed

+31
-10
lines changed

3 files changed

+31
-10
lines changed

doc/guide/install.rst

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -143,13 +143,31 @@ For advanced Python users or developers of CLIMADA, we recommed cloning the CLIM
143143
cd climada_python
144144
git checkout develop
145145
146-
#. Create an Anaconda environment called ``climada_env`` for installing CLIMADA.
147-
Use the default environment specs in ``env_climada.yml`` to create it.
146+
#. Create an Anaconda environment called ``climada_env`` for installing CLIMADA:
147+
148+
.. code-block:: shell
149+
150+
conda create -n climada_env python=3.9
151+
152+
.. note::
153+
154+
CLIMADA can be installed for different Python versions.
155+
If you want to use a different version, replace the version specification in the command above with another allowed version.
156+
157+
.. list-table::
158+
:width: 60%
159+
160+
* - **Supported Version**
161+
- ``3.9``
162+
* - Allowed Versions
163+
- ``3.9``, ``3.10``, ``3.11``
164+
165+
#. Use the default environment specs in ``env_climada.yml`` to install all dependencies.
148166
Then activate the environment:
149167

150168
.. code-block:: shell
151169
152-
conda env create -n climada_env -f requirements/env_climada.yml
170+
conda env update -n climada_env -f requirements/env_climada.yml
153171
conda activate climada_env
154172
155173
#. Install the local CLIMADA source files as Python package using ``pip``:
@@ -237,7 +255,6 @@ To install CLIMADA Petals, we assume you have already installed CLIMADA Core wit
237255
.. code-block:: shell
238256
239257
conda env update -n climada_env -f requirements/env_climada.yml
240-
conda env update -n climada_env -f requirements/env_developer.yml
241258
conda activate climada_env
242259
243260
#. Install the CLIMADA Petals package:
@@ -288,15 +305,20 @@ Basic Setup
288305

289306
See the VSCode docs on `Python <https://code.visualstudio.com/docs/python/python-tutorial>`_ and `Jupyter Notebooks <https://code.visualstudio.com/docs/datascience/jupyter-notebooks>`_ for further information.
290307

308+
.. hint::
309+
310+
Both of the following setup instructions work analogously for Core and Petals.
311+
The specific instructions for Petals are shown in square brackets: []
312+
291313
Workspace Setup
292314
"""""""""""""""
293315

294316
Setting up a workspace for the CLIMADA source code is only available for :ref:`advanced installations <install-advanced>`.
295317

296318
#. Open a new VSCode window.
297-
Below *Start*, click *Open...*, select the ``climada_python`` repository folder in your workspace directory, and click on *Open* on the bottom right.
319+
Below *Start*, click *Open...*, select the ``climada_python`` [``climada_petals``] repository folder in your workspace directory, and click on *Open* on the bottom right.
298320

299-
#. Click *File* > *Save Workspace As...* and store the workspace settings file next to (**not** in!) the ``climada_python`` folder.
321+
#. Click *File* > *Save Workspace As...* and store the workspace settings file next to (**not** in!) the ``climada_python`` [``climada_petals``] folder.
300322
This will enable you to load the workspace and all its specific settings in one go.
301323

302324
#. Open the Command Palette by clicking *View* > *Command Palette* or by using the shortcut keys ``Ctrl+Shift+P`` (Windows, Linux) / ``Cmd+Shift+P`` (macOS).
@@ -315,7 +337,7 @@ After you set up a workspace, you might want to configure the test explorer for
315337

316338
#. In the left sidebar, select the "Testing" symbol, and click on *Configure Python Tests*.
317339

318-
#. Select "pytest" as test framework and then select ``climada`` as the directory containing the test files.
340+
#. Select "pytest" as test framework and then select ``climada`` [``climada_petals``] as the directory containing the test files.
319341

320342
#. Select "Testing" in the Activity Bar on the left or through *View* > *Testing*.
321343
The "Test Explorer" in the left sidebar will display the tree structure of modules, files, test classes and individual tests.
@@ -407,7 +429,6 @@ To update, follow the instructions based on your :ref:`installation type <instal
407429
.. code-block:: shell
408430
409431
conda env update -n climada_env -f requirements/env_climada.yml
410-
conda env update -n climada_env -f requirements/env_developer.yml
411432
412433
The same instructions apply for CLIMADA Petals.
413434

requirements/env_climada.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ dependencies:
2626
- pycountry>=22.3
2727
- pyepsg>=0.4
2828
- pytables>=3.7
29-
- python=3.9
3029
- pyxlsb>=1.0
3130
- rasterio>=1.3
3231
- requests>=2.31

script/jenkins/install_env.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
#!/bin/bash -e
22

33
mamba remove --name climada_env --all
4-
mamba env create -f requirements/env_climada.yml --name climada_env
4+
mamba create -n climada_env python=3.9
5+
mamba env update -n climada_env -f requirements/env_climada.yml
56

67
source activate climada_env
78
python -m pip install -e "./[test]"

0 commit comments

Comments
 (0)