# Installation¶

Please execute the instructions of the following text boxes in a Terminal or Anaconda Prompt. Chose an installation directory, e.g., the user’s home directory. In the following it will be referred to as $[installation directory]. ## Install CLIMADA from sources¶ ### Download the latest version¶ cd$[installation directory]

git checkout develop
cd ..

### Set up the environment¶

It’s highly recommanded to install CLIMADA into a Conda environment. Without Conda, the installation of the dependencies can be cumbersome. If it is not already installed, download the latest version of Anaconda or Miniconda and execute it.

Open a command prompt (Windows) or shell (Mac, Linux) and run:

Include the CLIMADA path into the Conda environment as follows:

With this setup, changes to CLIMADA’s source code will immediately take effect. It removes the need to reinstall during development.

## Install CLIMADA from PyPi (alternative)¶

Published releases of CLIMADA (not CLIMADA-petals) can also be installed from the PyPi repository https://pypi.org/project/climada/, since version 3.0.

### Set up the environment¶

Download the environment specification file from the git repository and save it locally, then create the conda environment:

If this was successful, env_climada.yml can be safely deleted.

cd \$[installation directory]

git checkout develop
cd ..

### Update the environment¶

It is possible that CLIMADA-petals has slightly different dependencies than CLIMADA-core, hence the conda environment should be updated.

Include the CLIMADA-petals path into the Conda environment as follows:

In case of a separate environment for CLIMADA-petals, one needs to install the core package as well, either with the package from PyPi (pip install climada) or from local sources (pip install -e climada_python)

## Test the installation¶

Run the following command:

If the installation has been successful, an OK will appear at the end (the execution shouldn’t last more than 2 min).

### Run tutorials¶

In the Home section of Anaconda, with climada_env selected, install and launch jupyter notebook. A browser window will show up. Navigate to your climada_python repository and open doc/tutorial/1_main_CLIMADA.ipynb. This is the tutorial which will guide you through all CLIMADA’s functionalities. Execute each code cell to see the results, you might also edit the code cells before executing. See tutorials for more information.

## Working with Spyder¶

It is possible to use climada in combination with the Spyder-IDE. However, depending on OS, CLIMADA version, Spyder version and installation tool, installing spyder into the climada_env environment may fail. In particular, MacOS and conda install spyder don’t work well together. Although there are cases where pip install spyder bears satisfactory results, it is suggested to install spyder in a separate Conda environment and run it with the python interpreter from the climada_env environment instead. To do so, follow these instructions:

• Start Anaconda, create a new python_env environment (just click create and enter the name, then press Create) and install latest Spyder in there (currently 4.2.5). Start this version of Spyder. After Spyder has started, navigate to Preferences > Python Interpreter > Use the following interpreter and paste the output of the following terminal command into the text box:

python -c "import sys; print(sys.executable)"
# this returns a path, like /Users/XXX/opt/anaconda3/envs/climada_env/bin/python
• Obtain the version of the package spyder-kernels (currently 1.10.2) that has automatically been installed along with Spyder in the Anaconda environment and install the same version of spyder-kernels in the climada_env environment:

conda install spyder-kernels=1.10.2
• Start a new IPython console in Spyder and run tests_install.py.

## FAQs¶

• ModuleNotFoundError

• an external python library is not found. It might happen that the pip dependencies of env_climada.yml (the ones specified after pip:) have not been installed in the environment climada_env. They can be installed manually one by one as follows:

pip install library_name

where library_name is the missing library.
Another reason may be a recent update of the operating system (macOS). In this case removing and reinstalling Anaconda will be required.
• Conda permission error
(operation not permitted) in macOS Mojave: try the solutions suggested here https://github.com/conda/conda/issues/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_’ (climada v2.2.0).
• How to change the log level
By default the logging level is set to 'INFO', which is quite verbose. This can be changed
• through configuration, by editing the config file climada.conf (see Guide_configuration.ipynb) and setting the value of the global.log_level property.

• programmatically, globally, in a script or interactive python environment (Spyder, Jupyter, IPython) by executing e.g.,