Home

Awesome

DOI Build Status Documentation build status

CLIMADA

CLIMADA stands for CLIMate ADAptation and is a probabilistic natural catastrophe impact model, that also calculates averted damage (benefit) thanks to adaptation measures of any kind (from grey to green infrastructure, behavioural, etc.).

As of today, CLIMADA provides global coverage of major climate-related extreme-weather hazards at high resolution (4x4km) via a data API For select hazards, historic and probabilistic events sets, for past, present and future climate exist at distinct time horizons. You will find a repository containing scientific peer-reviewed articles that explain software components implemented in CLIMADA here.

CLIMADA is divided into two parts (two repositories):

  1. the core climada_python contains all the modules necessary for the probabilistic impact, the averted damage, uncertainty and forecast calculations. Data for hazard, exposures and impact functions can be obtained from the data API. Litpop is included as demo Exposures module, and Tropical cyclones is included as a demo Hazard module.
  2. the petals climada_petals contains all the modules for generating data (e.g., TC_Surge, WildFire, OpenStreeMap, ...). Most development is done here. The petals builds-upon the core and does not work as a stand-alone.

It is recommend for new users to begin with the core (1) and the tutorials therein.

This is the Python (3.9+) version of CLIMADA - please see here for backward compatibility with the MATLAB version.

Getting started

CLIMADA runs on Windows, macOS and Linux. The released versions of CLIMADA are available from conda-forge. Use the Mamba package manager to install it:

mamba install -c conda-forge climada

It is highly recommended to install CLIMADA into a separate Conda environment. See the installation guide for further information.

Follow the tutorials in a Jupyter Notebook to see what can be done with CLIMADA and how.

Documentation

The online documentation is available on Read the Docs.The documentation of each release version of CLIMADA can be accessed separately through the drop-down menu at the bottom of the left sidebar. Additionally, the version 'stable' refers to the most recent release (installed via conda), and 'latest' refers to the latest unstable development version (the develop branch).

CLIMADA python:

CLIMADA petals:

The documentation can also be built locally.

Citing CLIMADA

See the Citation Guide.

Please use the following logo if you are presenting results obtained with or through CLIMADA:

https://github.com/CLIMADA-project/climada_python/blob/main/doc/guide/img/CLIMADA_logo_QR.png

Contributing

We welcome any contribution to this repository, be it bugfixes and other code changes and additions, documentation improvements, or tutorial updates.

If you would like to contribute, please refer to our Contribution Guide.

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

License

Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.

CLIMADA is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License Version 3, 29 June 2007 as published by the Free Software Foundation, https://www.gnu.org/licenses/gpl-3.0.html

CLIMADA is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details: https://www.gnu.org/licenses/gpl-3.0.html