CLIMADA Installation Step by Step

System Requirements

  • OS: Linux, macOS, Windows

Prerequisites

  • Conda For the installation you will need the Conda package manager. If it is not yet installed, please download the latest version of Anaconda and execute it. On Windows you will have to restart your computer after installing Anaconda.

Instructions

  • Make a folder climada_workspace where you will save all your results. The folder shouldn’t be on a Cloud drive, like OneDrive, ICloud or PolyBox, as this may cause synchronization problems.

  • Open a ‘command line’ or ‘terminal’ or ‘anaconda prompt’ and navigate to the folder climada_workspace. Please get familiar with the ’anaconda prompt (all), the ‘command line’ (windows) or ‘terminal’ (linux, MacOs). Several resources are available online. Below ‘terminal’ and ‘command line’ and ‘anaconda prompt’ will be used interchangeably. To navigate use cd (replace path/to with the actual path to the directory you have created):

[1]:

cd path/to/climada_workspace

  • Download the Conda environment specifications for CLIMADA from the GitHub repository you can do it manually, by clicking on the link above, then on [Raw] and then saving the page that opens as env_climada.yml into the climada_workspace foldern alternatively just execute this command line:

[2]:

curl -o env_climada.yml https://raw.githubusercontent.com/CLIMADA-project/climada_python/main/requirements/env_climada.yml

  • Create the Conda environment

[3]:

conda env create -n climada_env -f env_climada.yml

Executing this command will take a while, expect 4 minutes or so.

  • Activate the environment

[4]:

conda activate climada_env

  • Install CLIMADA within the environment

[5]:

pip install climada

  • Test the installation

[6]:

python -m unittest climada.engine.test.test_impact
Note that at first it seems like nothing happens. At the beginning of the test some files are moved around in your local filesystem, which can take some time.
You will notice a climada folder in your home directory once the test has run - or after any python program executing import climada somewhere.
This directory contains data files that are used by climada and cached on the local file system for performance reasons. (See the Configuration Guide for further options.)
Later on, some text will appear. If all goes well, you should see an “Ok” at the end.

Great, now you are ready for some climate risk modelling!

Jupyter

To work with CLIMADA, we recommend that you work in a Jupyter Notebook in Jupyter Lab.
Please install jupyter lab executing the following command line:
[7]:

conda activate climada_env
pip install jupyterlab
Before starting a notebook, make sure to be in the conda environment climada_env. Here are the commands you should execute in your terminal.
The first line activates the environment and the second will open a Jupyer Lab console in your default web browser.
[8]:

conda activate climada_env
jupyter-lab

Once launched, you can create a new jupyter notebook or continue working with one you have already created.