Installation#

The following sections will guide you through the installation of CLIMADA and its dependencies.

Attention

CLIMADA has a complicated set of dependencies that cannot be installed with pip alone. Please follow the installation instructions carefully! We recommend to use Conda for creating a suitable software environment to execute CLIMADA.

All following instructions should work on any operating system (OS) that is supported by Conda, including in particular: Windows, macOS, and Linux.

Hint

If you need help with the vocabulary used on this page, refer to the Glossary.

Prerequisites#

Make sure you are using the latest version of your OS. Install any outstanding updates.
Free up at least 10 GB of free storage space on your machine. Conda and the CLIMADA dependencies will require around 5 GB of free space, and you will need at least that much additional space for storing the input and output data of CLIMADA.
Ensure a stable internet connection for the installation procedure. All dependencies will be downloaded from the internet. Do not use a metered, mobile connection!
Install the Conda environment management system. We highly recommend you use Miniforge, which includes the potent Mamba package manager. 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 Conda as Alternative to 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.

Decide on Your Entry Level!#

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 simple instructions.
If you want to use the very latest development version of CLIMADA or even develop new CLIMADA code, follow the advanced instructions.

Both approaches are not mutually exclusive. After successful installation, you may switch your setup at any time.

Notes on the CLIMADA Petals Package#

CLIMADA is divided into two packages, CLIMADA Core (climada_python) and CLIMADA Petals (climada_petals). The Core contains all the modules necessary for probabilistic impact, averted damage, uncertainty and forecast calculations. Data for hazard, exposures and impact functions can be obtained from the CLIMADA Data API. Hazard and Exposures subclasses are included as demonstrators only.

Attention

CLIMADA Petals is not a standalone module and requires CLIMADA Core to be installed!

CLIMADA Petals contains all the modules for generating data (e.g., TC_Surge, WildFire, OpenStreeMap, …). New modules are developed and tested here. Some data created with modules from Petals is available to download from the Data API. This works with just CLIMADA Core installed. CLIMADA Petals can be used to generate additional data of this type, or to have a look at the tutorials for all data types available from the API.

Both installation approaches mentioned above support CLIMADA Petals. If you are unsure whether you need Petals, you can install the Core first and later add Petals in both approaches.

Simple Instructions#

These instructions will install the most recent stable version of CLIMADA without cloning its repository.

Open the command line. Create a new Conda environment with CLIMADA by executing
```
mamba create -n climada_env -c conda-forge climada
```
Activate the environment:
```
mamba activate climada_env
```
You should now see (climada_env) appear in the beginning of your command prompt. This means the environment is activated.
Verify that everything is installed correctly by executing a single test:
```
python -m unittest climada.engine.test.test_impact
```
Executing CLIMADA for the first time will take some time because it will generate a directory tree in your home/user directory. After a while, some text should appear in your terminal. In the end, you should see an “Ok”. If so, great! You are good to go.

Optional: Install CLIMADA Petals into the environment:

mamba install -n climada_env -c conda-forge climada-petals

Advanced Instructions#

For advanced Python users or developers of CLIMADA, we recommed cloning the CLIMADA repository and installing the package from source.

Warning

If you followed the Simple Instructions before, make sure you either remove the environment with

mamba env remove -n climada_env

before you continue, or you use a different environment name for the following instructions (e.g. climada_dev instead of climada_env).

If you are using a Linux OS, make sure you have git installed (Windows and macOS users are good to go once Conda is installed). On Ubuntu and Debian, you may use APT:
```
apt update
apt install git
```
Both commands will probably require administrator rights, which can be enabled by prepending sudo.
Create a folder for your code. We will call it workspace directory. To make sure that your user can manipulate it without special privileges, use a subdirectory of your user/home directory. Do not use a directory that is synchronized by cloud storage systems like OneDrive, iCloud or Polybox!
Open the command line and navigate to the workspace directory you created using cd. Replace <path/to/workspace> with the path of the workspace directory:
```
cd <path/to/workspace>
```
Clone CLIMADA from its GitHub repository. Enter the directory and check out the branch of your choice. The latest development version will be available under the branch develop.
```
git clone https://github.com/CLIMADA-project/climada_python.git
cd climada_python
git checkout develop
```
Create an Conda environment called climada_env for installing CLIMADA:
```
mamba create -n climada_env "python=3.11.*"
```
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

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.

Supported Version

3.11

Allowed Versions

3.9, 3.10, 3.11
Use the default environment specs in env_climada.yml to install all dependencies. Then activate the environment:
```
mamba env update -n climada_env -f requirements/env_climada.yml
mamba activate climada_env
```
Install the local CLIMADA source files as Python package using pip:
```
python -m pip install -e ./
```
Hint

Using a path ./ (referring to the path you are currently located at) will instruct pip to install the local files instead of downloading the module from the internet. The -e (for “editable”) option further instructs pip to link to the source files instead of copying them during installation. This means that any changes to the source files will have immediate effects in your environment, and re-installing the module is never required.
Verify that everything is installed correctly by executing a single test:
```
python -m unittest climada.engine.test.test_impact
```
Executing CLIMADA for the first time will take some time because it will generate a directory tree in your home/user directory. If this test passes, great! You are good to go.

Install Developer Dependencies (Optional)#

Building the documentation and running the entire test suite of CLIMADA requires additional dependencies which are not installed by default. They are also not needed for using CLIMADA. However, if you want to develop CLIMADA, we recommend you install them.

With the climada_env activated, enter the workspace directory and then the CLIMADA repository as above. Then, add the dev extra specification to the pip install command (mind the quotation marks, and see also pip install examples):

python -m pip install -e "./[dev]"

The CLIMADA Python package defines the following extras:

Extra	Includes Dependencies…
`doc`	for building documentation
`test`	for running and evaluating tests
`dev`	combination of `doc` and `test`

For executing the pre-defined test scripts in exactly the same way as they are executed by the automated CI pipeline, you will need make to be installed. On macOS and on Linux it is pre-installed. On Windows, it can easily be installed with Conda:

mamba install -n climada_env make

Instructions for running the test scripts can be found in the Testing Guide.

Install CLIMADA Petals (Optional)#

If you are unsure whether you need Petals, see the notes above.

To install CLIMADA Petals, we assume you have already installed CLIMADA Core with the advanced instructions above.

Open the command line and navigate to the workspace directory.
Clone CLIMADA Petals from its repository. Enter the directory and check out the branch of your choice. The latest development version will be available under the branch develop.
```
git clone https://github.com/CLIMADA-project/climada_petals.git
cd climada_petals
git checkout develop
```

Update the Conda environment with the specifications from Petals and activate it:

mamba env update -n climada_env -f requirements/env_climada.yml
mamba activate climada_env

Install the CLIMADA Petals package:
```
python -m pip install -e ./
```

JupyterLab#

Install JupyterLab into the Conda environment:

mamba install -n climada_env -c conda-forge jupyterlab

Make sure that the climada_env is activated (see above) and then start JupyterLab:
```
mamba activate climada_env
jupyter-lab
```
JupyterLab will open in a new window of your default browser.

Visual Studio Code (VSCode)#

Basic Setup#

Download and install VSCode following the instructions on https://code.visualstudio.com/.
Install the Python and Jupyter extensions. In the left sidebar, select the “Extensions” symbol, enter “Python” in the search bar and click Install next to the “Python” extension. Repeat this process for “Jupyter”.
Open a Jupyter Notebook or create a new one. On the top right, click on Select Kernel, select Python Environments… and then choose the Python interpreter from the climada_env.

See the VSCode docs on Python and Jupyter Notebooks for further information.

Hint

Both of the following setup instructions work analogously for Core and Petals. The specific instructions for Petals are shown in square brackets: []

Workspace Setup#

Setting up a workspace for the CLIMADA source code is only available for advanced installations.

Open a new VSCode window. Below Start, click Open…, select the climada_python [climada_petals] repository folder in your workspace directory, and click on Open on the bottom right.
Click File > Save Workspace As… and store the workspace settings file next to (not in!) the climada_python [climada_petals] folder. This will enable you to load the workspace and all its specific settings in one go.
Open the Command Palette by clicking View > Command Palette or by using the shortcut keys Ctrl+Shift+P (Windows, Linux) / Cmd+Shift+P (macOS). Start typing “Python: Select Interpreter” and select it from the dropdown menu. If prompted, choose the option to set the interpreter for the workspace, not just the current folder. Then, choose the Python interpreter from the climada_env.

For further information, refer to the VSCode docs on Workspaces.

Test Explorer Setup#

After you set up a workspace, you might want to configure the test explorer for easily running the CLIMADA test suite within VSCode.

Note

Please install the additional test dependencies before proceeding.

In the left sidebar, select the “Testing” symbol, and click on Configure Python Tests.
Select “pytest” as test framework and then select climada [climada_petals] as the directory containing the test files.
Select “Testing” in the Activity Bar on the left or through View > Testing. The “Test Explorer” in the left sidebar will display the tree structure of modules, files, test classes and individual tests. You can run individual tests or test subtrees by clicking the Play buttons next to them.
By default, the test explorer will show test output for failed tests when you click on them. To view the logs for any test, click on View > Output, and select “Python Test Log” from the dropdown menu in the view that just opened. If there are errors during test discovery, you can see what’s wrong in the “Python” output.

For further information, see the VSCode docs on Python Testing.

Spyder#

Installing Spyder into the existing Conda environment for CLIMADA might fail depending on the exact versions of dependencies installed. Therefore, we recommend installing Spyder in a separate environment, and then connecting it to a kernel in the original climada_env.

Follow the Spyder installation instructions. You can follow the “Conda” installation instructions. Keep in mind you are using mamba, though!
Check the version of the Spyder kernel in the new environment:
```
mamba env export -n spyder-env | grep spyder-kernels
```
This will return a line like this:
```
- spyder-kernels=X.Y.Z=<hash>
```
Copy the part spyder-kernels=X.Y.Z (until the second =) and paste it into the following command to install the same kernel version into the climada_env:
```
mamba install -n climada_env spyder-kernels=X.Y.Z
```
Obtain the path to the Python interpreter of your climada_env. Execute the following commands:
```
mamba activate climada_env
python -c "import sys; print(sys.executable)"
```
Copy the resulting path.
Open Spyder through the command line:
```
mamba activate spyder-env
spyder
```
Set the Python interpreter used by Spyder to the one of climada_env. Select Preferences > Python Interpreter > Use the following interpreter and paste the iterpreter path you copied from the climada_env.

FAQs#

Answers to frequently asked questions.

Updating CLIMADA#

We recommend keeping CLIMADA up-to-date. To update, follow the instructions based on your installation type:

Simple Instructions: Update CLIMADA using mamba:

mamba update -n climada_env -c conda-forge climada

Advanced Instructions: Move into your local CLIMADA repository and pull the latest version of your respective branch:
```
cd <path/to/workspace>/climada_python
git pull
```
Then, update the environment and reinstall the package:
```
mamba env update -n climada_env -f requirements/env_climada.yml
mamba activate climada_env
python -m pip install -e ./
```
The same instructions apply for CLIMADA Petals.

Installing More Packages#

You might use CLIMADA in code that requires more packages than the ones readily available in the CLIMADA Conda environment. If so, prefer installing these packages via Conda, and only rely on pip if that fails. The default channels of Conda sometimes contain outdated versions. Therefore, use the conda-forge channel:

mamba install -n climada_env -c conda-forge <package>

Only if the desired package (version) is not available, go for pip:

mamba activate climada_env
python -m pip install <package>

Verifying Your Installation#

If you followed the installation instructions, you already executed a single unit test. This test, however, will not cover all issues that could occur within your installation setup. If you are unsure if everything works as intended, try running all unit tests. This is only available for advanced setups! Move into the CLIMADA repository, activate the environment and then execute the tests:

cd <path/to/workspace>/climada_python
mamba activate climada_env
python -m unittest discover -s climada -p "test*.py"

Error: `ModuleNotFoundError`#

Something is wrong with the environment you are using. After each of the following steps, check if the problem is solved, and only continue if it is not:

Make sure you are working in the CLIMADA environment:
```
mamba activate climada_env
```
Update the Conda environment and CLIMADA.
Conda will notify you if it is not up-to-date. In this case, follow its instructions to update it. Then, repeat the last step and update the environment and CLIMADA (again).
Install the missing package manually. Follow the instructions for installing more packages.
If you reached this point, something is severely broken. The last course of action is to delete your CLIMADA environment:
```
mamba deactivate
mamba env remove -n climada_env
```
Now repeat the installation process.
Still no good? Please raise an issue on GitHub to get help.

Logging Configuration#

Climada makes use of the standard logging package. By default, the “climada”-Logger is detached from logging.root, logging to stdout with the level set to WARNING.

If you prefer another logging configuration, e.g., for using Climada embedded in another application, you can opt out of the default pre-configuration by setting the config value for logging.climada_style to false in the configuration file climada.conf.

Changing the logging level can be done in multiple ways:

Adjust the configuration file climada.conf by setting a the value of the global.log_level property. This only has an effect if the logging.climada_style is set to true though.

Set a global logging level in your Python script:

import logging
logging.getLogger('climada').setLevel(logging.ERROR)  # to silence all warnings

Set a local logging level in a context manager:

from climada.util import log_level
with log_level(level="INFO"):
    # This also emits all info log messages
    foo()

# Default logging level again
bar()

All three approaches can also be combined.

Conda as Alternative to Mamba#

We experienced several issues with the default conda package manager lately. This is likely due to the large dependency set of CLIMADA, which makes solving the environment a tedious task. We therefore switched to the more performant mamba and recommend using it.

Caution

In theory, you could also use an Anaconda or Miniconda distribution and replace every mamba command in this guide with conda. In practice, however, conda is often unable to solve an environment that mamba solves without issues in few seconds.

Error: `operation not permitted`#

Conda might report a permission error on macOS Mojave. Carefully follow these instructions: conda/conda#8440

No `impf_TC` Column in `GeoDataFrame`#

This may happen when a demo file from CLIMADA was not updated after the change in the impact function naming pattern from if_ to impf_ when CLIMADA v2.2.0 was released. Execute

mamba activate climada_env
python -c "import climada; climada.setup_climada_data(reload=True)"

The What Now? (Glossary)#

You might have become confused about all the names thrown at you. Let’s clear that up:

Terminal, Command Line: A text-only program for interacting with your computer (the old fashioned way). If you are using Miniforge on Windows, the program is called “Miniforge Prompt”.
Conda: A cross-platform package management system. Comes in different varieties (distributions).
Mamba: The faster reimplementation of the conda package manager.
Environment (Programming): A setup where only a specific set of modules and programs can interact. This is especially useful if you want to install programs with mutually incompatible requirements.
pip: The Python package installer.
git: A popular version control software for programming code (or any text-based set of files).
GitHub: A website that publicly hosts git repositories.
git Repository: A collection of files and their entire revision/version history, managed by git.
Cloning: The process and command (git clone) for downloading a git repository.
IDE: Integrated Development Environment. A fancy source code editor tailored for software development and engineering.

Supported Version	`3.11`
Allowed Versions	`3.9`, `3.10`, `3.11`

Installation

Contents

Installation#

Prerequisites#

Decide on Your Entry Level!#

Notes on the CLIMADA Petals Package#

Simple Instructions#

Advanced Instructions#

Install Developer Dependencies (Optional)#

Install CLIMADA Petals (Optional)#

JupyterLab#

Visual Studio Code (VSCode)#

Basic Setup#

Workspace Setup#

Test Explorer Setup#

Spyder#

FAQs#

Updating CLIMADA#

Installing More Packages#

Verifying Your Installation#

Error: ModuleNotFoundError#

Logging Configuration#

Conda as Alternative to Mamba#

Error: operation not permitted#

No impf_TC Column in GeoDataFrame#

The What Now? (Glossary)#

Error: `ModuleNotFoundError`#

Error: `operation not permitted`#

No `impf_TC` Column in `GeoDataFrame`#