How to navigate this documentation#

This page is a short summary of the different sections and guides here, to help you find the information that you need to get started.

Each top section has its own landing page, presenting the essential elements in brief, and often several subsections, which go more into details.

Getting started#

The Getting started section, where you are currently, presents the very basics of climada.

For instance, to start learning about CLIMADA, you can have a look at the introduction.

You can also have a look at the paper repository to get an overview of research projects conducted with CLIMADA.

Programming in Python#

It is best to have some basic knowledge of Python programming before starting with CLIMADA. But if you need a quick introduction or reminder, have a look at the short Python Tutorial. Also have a look at the python Python Dos and Don’t guide and at the Python Performance Guide for best practice tips.

Tutorials#

A good way to start using CLIMADA is to have a look at the tutorials in the User Guide. The 10 minute climada tutorial will give you a quick introduction to CLIMADA, with a brief example on how to calculate you first impacts, as well as your first appraisal of adaptation options, while the Overview will present the whole structure of CLIMADA more in depth. You can then look at the specific tutorials for each module (for example if you are interested in a specific hazard, like Tropical Cyclones, or in learning to estimate the value of asset exposure,…).

Contributing#

If you would like to participate in the development of CLIMADA, carefully read the Developer Guide. Here you will find how to set up an environment to develop new features for CLIMADA, the workflow and rules to follow to make sure you can implement a valuable contribution!

API Reference#

The API reference presents the documentation of the internal modules, classes, methods and function of CLIMADA.

Changelog#

In the Changelog section, you can have a look at all the changes made between the different versions of CLIMADA

External links#

The top bar of this website also link to the documentation of Climada Petals, the webpage of the Weather and Climate Risk group at ETH, and the official CLIMADA website.