You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.).
3
+
[CLIMADA](https://climada.ethz.ch/climada/) (CLIMate ADAptation) is a free and open-source software framework for climate risk assessment and adaptation
4
+
option appraisal. Designed by a large scientific community, it helps reasearchers, policymakers, and businesses analyse the impacts of natural hazards and
5
+
explore adaptation strategies.
4
6
5
-
As of today, CLIMADA provides global coverage of major climate-related extreme-weather hazards at high resolution via a [data API](https://climada.ethz.ch/data-api/v1/docs), namely (i) tropical cyclones, (ii) river flood, (iii) agro drought and (iv) European winter storms, all at 4km spatial resolution - wildfire to be added soon. For all hazards, historic and probabilistic event sets exist, for some also under select climate forcing scenarios (RCPs) at distinct time horizons (e.g. 2040). See also [papers](https://github.com/CLIMADA-project/climada_papers) for details.
7
+
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.
8
+
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).
6
9
7
10
CLIMADA is divided into two parts (two repositories):
8
11
@@ -11,73 +14,63 @@ CLIMADA is divided into two parts (two repositories):
11
14
12
15
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.
13
16
14
-
This is the Python (3.8+) version of CLIMADA - please see https://github.com/davidnbresch/climada for backward compatibility (MATLAB).
17
+
This is the Python version of CLIMADA - please see [here](https://github.com/davidnbresch/climada) for backward compatibility with the MATLAB version.
15
18
16
19
## Getting started
17
20
18
21
CLIMADA runs on Windows, macOS and Linux.
19
-
The released versions of CLIMADA are available from [conda-forge](https://anaconda.org/conda-forge/climada-petals).
22
+
The released versions of CLIMADA are available from [conda-forge](https://anaconda.org/conda-forge/climada).
20
23
Use the [Mamba](https://mamba.readthedocs.io/en/latest/) package manager to install it:
21
24
22
25
```shell
23
-
mamba install -c conda-forge climada-petals
26
+
mamba install -c conda-forge climada
24
27
```
25
28
26
29
It is **highly recommended** to install CLIMADA into a **separate** Conda environment.
27
30
See the [installation guide](https://climada-python.readthedocs.io/en/latest/guide/install.html) for further information.
28
31
29
-
Follow the [tutorial](https://climada-python.readthedocs.io/en/latest/tutorial/1_main_climada.html)`climada_python-x.y.z/doc/tutorial/1_main_climada.ipynb` in a Jupyter Notebook to see what can be done with CLIMADA and how.
32
+
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.
30
33
31
34
## Documentation
32
35
33
-
Documentation is available on Read the Docs:
34
-
35
-
Note that all the documentations has two versions,'latest' and 'stable', and explicit version numbers, such as 'v3.1.1', in the url path. 'latest' is created from the 'develop' branch and has the latest changes by developers, 'stable' from the latest release. For more details about documentation versions, please have a look at [here](https://readthedocs.org/projects/climada-python/versions/).
36
+
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).
-[petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
47
49
48
50
The documentation can also be [built locally](https://climada-python.readthedocs.io/en/latest/README.html).
49
51
50
52
## Citing CLIMADA
51
53
52
-
If you use CLIMADA please cite (in general, in particular for academic work) :
53
-
54
-
The [used version](https://zenodo.org/search?page=1&size=20&q=climada)
55
-
56
-
and/or the following published articles:
57
-
58
-
Aznar-Siguan, G. and Bresch, D. N., 2019: CLIMADA v1: a global weather and climate risk assessment platform, Geosci. Model Dev., 12, 3085–3097, https://doi.org/10.5194/gmd-12-3085-2019
54
+
See the [Citation Guide](https://climada-python.readthedocs.io/en/latest/misc/citation.html).
59
55
60
-
Bresch, D. N. and Aznar-Siguan, G., 2021: CLIMADA v1.4.1: towards a globally consistent adaptation options appraisal tool, Geosci. Model Dev., 14, 351-363, https://doi.org/10.5194/gmd-14-351-2021
56
+
Please use the following logo if you are presenting results obtained with or through CLIMADA:
61
57
62
-
Please see all CLIMADA-related scientific publications in our [repository of scientific publications](https://github.com/CLIMADA-project/climada_papers) and cite according to your use of select features, be it hazard set(s), exposure(s) ...
63
-
64
-
In presentations or other graphical material, as well as in reports etc., where applicable, please add the logo as follows:\
As key link, please use https://wcr.ethz.ch/research/climada.html, as it will last and provides a bit of an intro, especially for those not familiar with GitHub - plus a nice CLIMADA infographic towards the bottom of the page
68
-
69
60
## Contributing
70
61
71
-
See the [Contribution Guide](https://climada-python.readthedocs.io/en/latest/misc/CONTRIBUTING.html).
62
+
We welcome any contribution to this repository, be it bugfixes and other code changes and additions, documentation improvements, or tutorial updates.
63
+
64
+
If you would like to contribute, please refer to our [Contribution Guide](CONTRIBUTING.md).
72
65
73
66
## Versioning
74
67
75
-
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/CLIMADA-project/climada_petals/releases).
68
+
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).
76
69
77
70
## License
78
71
79
72
Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.
80
73
81
-
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
74
+
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>
82
75
83
-
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
76
+
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>
0 commit comments