Skip to content

Commit 969c92b

Browse files
change short description in README.md (#1014)
* README.md change short description of climada * cosmetics * markdown linting
1 parent 7d852d6 commit 969c92b

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
# CLIMADA
66

7-
[CLIMADA](https://climada.ethz.ch/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.).
7+
[CLIMADA](https://climada.ethz.ch/climada/) (CLIMate ADAptation) is a free and open-source software framework for climate risk assessment and adaptation
8+
option appraisal. Designed by a large scientific community, it helps reasearchers, policymakers, and businesses analyse the impacts of natural hazards and
9+
explore adaptation strategies.
810

911
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.
1012
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).
@@ -37,18 +39,17 @@ Follow the [tutorials](https://climada-python.readthedocs.io/en/stable/tutorial/
3739

3840
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).
3941

40-
4142
CLIMADA python:
4243

43-
* [online (recommended)](https://climada-python.readthedocs.io/en/latest/)
44-
* [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)
45-
* [core Tutorials on GitHub](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial)
44+
- [online (recommended)](https://climada-python.readthedocs.io/en/latest/)
45+
- [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)
46+
- [core Tutorials on GitHub](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial)
4647

4748
CLIMADA petals:
4849

49-
* [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)
50-
* [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)
51-
* [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
50+
- [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)
51+
- [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)
52+
- [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
5253

5354
The documentation can also be [built locally](https://climada-python.readthedocs.io/en/latest/README.html).
5455

@@ -74,6 +75,6 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
7475

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

77-
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
78+
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>
7879

79-
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
80+
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>

doc/misc/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# CLIMADA
22

3-
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.
46

57
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.
68
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).
@@ -33,18 +35,17 @@ Follow the [tutorials](https://climada-python.readthedocs.io/en/stable/tutorial/
3335

3436
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).
3537

36-
3738
CLIMADA python:
3839

39-
* [online (recommended)](https://climada-python.readthedocs.io/en/latest/)
40-
* [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)
41-
* [core Tutorials on GitHub](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial)
40+
- [online (recommended)](https://climada-python.readthedocs.io/en/latest/)
41+
- [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)
42+
- [core Tutorials on GitHub](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial)
4243

4344
CLIMADA petals:
4445

45-
* [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)
46-
* [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)
47-
* [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
46+
- [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)
47+
- [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)
48+
- [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
4849

4950
The documentation can also be [built locally](https://climada-python.readthedocs.io/en/latest/README.html).
5051

@@ -70,6 +71,6 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
7071

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

73-
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>
7475

75-
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

Comments
 (0)