Skip to content

Commit 97b108b

Browse files
getting started
1 parent 68d2f3d commit 97b108b

File tree

1 file changed

+45
-31
lines changed

1 file changed

+45
-31
lines changed

doc/getting-started/index.rst

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,66 +2,80 @@
22
Getting started
33
===================
44

5-
Quick installation
6-
--------------------
5+
Installation
6+
-------------------
77

8-
Are you already working with mamba or conda? proceed to install CLIMADA by executing the following line in the terminal::
98

10-
mamba create -n climada_env -c conda-forge climada
9+
10+
Are you already working with conda ? proceed to install CLIMADA by executing the following line in the terminal::
11+
12+
conda create -n climada_env -c conda-forge climada
1113

1214
Each time you will want to work with CLIMADA, simply activate the environnment::
1315

14-
mamba activate climada_env
16+
conda activate climada_env
1517

1618
You are good to go!
1719

20+
1821
.. seealso::
1922

20-
You don't have mamba or conda installed or you are looking for advanced installation instructions? Look up our :doc:`detailed instructions <install>` on CLIMADA installation.
23+
You don't have conda installed or you are looking for advaced installation instructions ? Look up our `detailed instructions <http://www.python.org>`__ on CLIMADA installation.
2124

2225

2326
.. dropdown:: How does CLIMADA compute impacts ?
2427
:color: primary
25-
:icon: unlock
2628

27-
And some content!
28-
29-
.. dropdown:: How do you create an Hazard ?
29+
CLIMADA computes impacts following the IPCC risk framework by combining hazard intensity, exposure, and vulnerability
30+
data. It models hazards intensity (e.g., tropical cyclones, floods) using
31+
historical event sets or stochastic simulations, overlaying them with spatial exposure data
32+
(e.g., population, infrastructure), and applies vulnerability functions that estimate damage or
33+
loss, given the hazard intensity. By aggregating these results, CLIMADA calculates expected
34+
impacts, such as economic losses or affected populations.
35+
.. dropdown:: How do you create a Hazard ?
3036
:color: primary
31-
:icon: unlock
3237

33-
And some content!
38+
From a risk perspective, the intersting aspect of a natural hazard is its location and intensity. For such,
39+
CLIMADA allows you to load your own hazard data or to directly define it using the platform. As an example,
40+
Users can easily load historical tropical cyclone tracks (IBTracks) and apply stochastic methods to generate
41+
a larger ensemble of tracks from the historical ones, from which they can easily compute the maximal windspeed.
3442

3543
.. dropdown:: How do we define an exposure ?
3644
:color: primary
37-
:icon: unlock
3845

39-
And some content!
46+
Exposure is defined as the entity that could potentially be damaged by a hazard: it can be people, infrastructures,
47+
assests, ecosystems or others. The CLIMADA user is given the option to load its own exposure data into the platform,
48+
or to use CLIMADA to define it. One common way of defining assets' exposure is through LitPop (link). LitPop dissagrate a
49+
financial index, as the GDP of a country for instance, to a much finer resolution proportionally to population
50+
density and nighlight intensity.
4051

41-
.. dropdown:: How do we model vulnerability ?
52+
.. dropdown:: What are centroids ?
4253
:color: primary
43-
:icon: unlock
4454

45-
And some content!
55+
How can you compute the impact of a hazard on an exposure if their locations differs ? Well, you can't.
56+
This is what cetroids are for. Centroids are a grid of points defined by the users, in which both the exposure value
57+
and hazard intensity are calculated, allowing you to obtain the asset value and the hazard intensity im those
58+
defined points.
4659

47-
.. dropdown:: Do you want to quantify the uncertainties ?
60+
.. dropdown:: How do we model vulnerability ?
4861
:color: primary
49-
:icon: unlock
5062

51-
And some content!
63+
Vulnerability curves, also known as impact functions, tie the link between hazard intensity and damage.
64+
CLIMADA offers built-in sigmoidal or step-wise vulnerability curves, or allows you to calibrate your own
65+
impact functions with damage and hazard data through the calibration module (link).
66+
67+
(image many impact functions and optimal)
5268

53-
.. dropdown:: Compare adaptation measures and assess their cost effectiveness
69+
.. dropdown:: Do you want to quantify the uncertainties ?
5470
:color: primary
55-
:icon: unlock
5671

57-
And some content!
72+
CLIMADA provides a dedicated module ([unsequa link]) for conducting uncertainty and sensitivity analyses.
73+
This module allows you to define a range of input parameters and evaluate their influence on the output,
74+
helping you quantify the sensitivity of the modeling chain as well as the uncertainties in your results.
5875

59-
.. toctree::
60-
:maxdepth: 1
61-
:hidden:
76+
.. dropdown:: Compare adaptation measures and assess their cost-effectiveness
77+
:color: primary
6278

63-
Introduction <Guide_Introduction>
64-
Navigate this documentation <Guide_get_started>
65-
Installation instructions <install>
66-
How to cite CLIMADA <../misc/citation>
67-
Python introduction <0_intro_python>
79+
Is there an adaptation measure that will decrease the impact? Does the cost needed to implement such
80+
measure outweight the gains? All these questions can be asnwered using the cost-benefit module (link adaptation).
81+
With this module, users can define and compare adaptation measures to establish their cost-effectiveness.

0 commit comments

Comments
 (0)