[](https://zenodo.org/badge/latestdoi/112729129)
[](http://ied-wcr-jenkins.ethz.ch/job/climada_branches/)
[](https://readthedocs.org/projects/climada-python/builds/)
# CLIMADA
CLIMADA stands for **CLIM**ate **ADA**ptation 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](https://climada.ethz.ch/data-api/v1/docs) 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](https://github.com/CLIMADA-project/climada_papers).
CLIMADA is divided into two parts (two repositories):
1. the core [climada_python](https://github.com/CLIMADA-project/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](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_util_api_client.ipynb). [Litpop](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_entity_LitPop.ipynb) is included as demo Exposures module, and [Tropical cyclones](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_hazard_TropCyclone.ipynb) is included as a demo Hazard module.
2. the petals [climada_petals](https://github.com/CLIMADA-project/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](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial) therein.
This is the Python (3.9+) version of CLIMADA - please see [here](https://github.com/davidnbresch/climada) 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](https://anaconda.org/conda-forge/climada).
Use the [Mamba](https://mamba.readthedocs.io/en/latest/) package manager to install it:
```shell
mamba install -c conda-forge climada
```
It is **highly recommended** to install CLIMADA into a **separate** Conda environment.
See the [installation guide](https://climada-python.readthedocs.io/en/latest/guide/install.html) for further information.
Follow the [tutorials](https://climada-python.readthedocs.io/en/stable/tutorial/1_main_climada.html) in a Jupyter Notebook to see what can be done with CLIMADA and how.
## Documentation
The online documentation is available on [Read the Docs](https://climada-python.readthedocs.io/en/stable/).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:
* [online (recommended)](https://climada-python.readthedocs.io/en/latest/)
* [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)
* [core Tutorials on GitHub](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial)
CLIMADA petals:
* [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)
* [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)
* [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
The documentation can also be [built locally](https://climada-python.readthedocs.io/en/latest/README.html).
## Citing CLIMADA
See the [Citation Guide](https://climada-python.readthedocs.io/en/latest/misc/citation.html).
Please use the following logo if you are presenting results obtained with or through CLIMADA:
## 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](CONTRIBUTING.md).
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/CLIMADA-project/climada_python/releases).
## 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
Raw data
{
"_id": null,
"home_page": "https://github.com/CLIMADA-project/climada_python",
"name": "climada",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<3.12",
"maintainer_email": "",
"keywords": "climate adaptation",
"author": "ETH",
"author_email": "schmide@ethz.ch",
"download_url": "https://files.pythonhosted.org/packages/2b/73/331536ccc56f7bb8d4bd63d65071fce92ea2652601e83a36f2772792b330/climada-4.1.1.tar.gz",
"platform": null,
"description": "[](https://zenodo.org/badge/latestdoi/112729129)\n[](http://ied-wcr-jenkins.ethz.ch/job/climada_branches/)\n[](https://readthedocs.org/projects/climada-python/builds/)\n\n# CLIMADA\n\nCLIMADA stands for **CLIM**ate **ADA**ptation 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.).\n\nAs of today, CLIMADA provides global coverage of major climate-related extreme-weather hazards at high resolution (4x4km) via a [data API](https://climada.ethz.ch/data-api/v1/docs) For select hazards, historic and probabilistic events sets, for past, present and future climate exist at distinct time horizons.\nYou will find a repository containing scientific peer-reviewed articles that explain software components implemented in CLIMADA [here](https://github.com/CLIMADA-project/climada_papers).\n\nCLIMADA is divided into two parts (two repositories):\n\n1. the core [climada_python](https://github.com/CLIMADA-project/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](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_util_api_client.ipynb). [Litpop](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_entity_LitPop.ipynb) is included as demo Exposures module, and [Tropical cyclones](https://github.com/CLIMADA-project/climada_python/blob/main/doc/tutorial/climada_hazard_TropCyclone.ipynb) is included as a demo Hazard module.\n2. the petals [climada_petals](https://github.com/CLIMADA-project/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.\n\nIt is recommend for new users to begin with the core (1) and the [tutorials](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial) therein.\n\nThis is the Python (3.9+) version of CLIMADA - please see [here](https://github.com/davidnbresch/climada) for backward compatibility with the MATLAB version.\n\n## Getting started\n\nCLIMADA runs on Windows, macOS and Linux.\nThe released versions of CLIMADA are available from [conda-forge](https://anaconda.org/conda-forge/climada).\nUse the [Mamba](https://mamba.readthedocs.io/en/latest/) package manager to install it:\n\n```shell\nmamba install -c conda-forge climada\n```\n\nIt is **highly recommended** to install CLIMADA into a **separate** Conda environment.\nSee the [installation guide](https://climada-python.readthedocs.io/en/latest/guide/install.html) for further information.\n\nFollow the [tutorials](https://climada-python.readthedocs.io/en/stable/tutorial/1_main_climada.html) in a Jupyter Notebook to see what can be done with CLIMADA and how.\n\n## Documentation\n\nThe online documentation is available on [Read the Docs](https://climada-python.readthedocs.io/en/stable/).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).\n\n\nCLIMADA python:\n\n* [online (recommended)](https://climada-python.readthedocs.io/en/latest/)\n* [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)\n* [core Tutorials on GitHub](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial)\n\nCLIMADA petals:\n\n* [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)\n* [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)\n* [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)\n\nThe documentation can also be [built locally](https://climada-python.readthedocs.io/en/latest/README.html).\n\n## Citing CLIMADA\n\nSee the [Citation Guide](https://climada-python.readthedocs.io/en/latest/misc/citation.html).\n\nPlease use the following logo if you are presenting results obtained with or through CLIMADA:\n\n\n\n## Contributing\n\nWe welcome any contribution to this repository, be it bugfixes and other code changes and additions, documentation improvements, or tutorial updates.\n\nIf you would like to contribute, please refer to our [Contribution Guide](CONTRIBUTING.md).\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/CLIMADA-project/climada_python/releases).\n\n## License\n\nCopyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.\n\nCLIMADA 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\n\nCLIMADA 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\n",
"bugtrack_url": null,
"license": "OSI Approved :: GNU Lesser General Public License v3 (GPLv3)",
"summary": "CLIMADA in Python",
"version": "4.1.1",
"project_urls": {
"Homepage": "https://github.com/CLIMADA-project/climada_python"
},
"split_keywords": [
"climate",
"adaptation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "751cc92f495c3c121aedf0d870243ac2b202047ea1c43ea371d5a0ae41bb783a",
"md5": "1e1ab7681e0530296de0360d2756cefd",
"sha256": "1aaae5901e376277e47e3b8f2336e4596bb7fc5c685a006c08d0ab767e9364c0"
},
"downloads": -1,
"filename": "climada-4.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e1ab7681e0530296de0360d2756cefd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.12",
"size": 7917985,
"upload_time": "2024-02-21T09:45:13",
"upload_time_iso_8601": "2024-02-21T09:45:13.847184Z",
"url": "https://files.pythonhosted.org/packages/75/1c/c92f495c3c121aedf0d870243ac2b202047ea1c43ea371d5a0ae41bb783a/climada-4.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b73331536ccc56f7bb8d4bd63d65071fce92ea2652601e83a36f2772792b330",
"md5": "1144687358d1f4bc5ff1a97834fa767f",
"sha256": "349c311247df23b0a010b2573367691cb33be3e2cd967888aad1f1c4cc9c9040"
},
"downloads": -1,
"filename": "climada-4.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1144687358d1f4bc5ff1a97834fa767f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.12",
"size": 29520156,
"upload_time": "2024-02-21T09:45:16",
"upload_time_iso_8601": "2024-02-21T09:45:16.424506Z",
"url": "https://files.pythonhosted.org/packages/2b/73/331536ccc56f7bb8d4bd63d65071fce92ea2652601e83a36f2772792b330/climada-4.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 09:45:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CLIMADA-project",
"github_project": "climada_python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "climada"
}
JSON
