Skip to content

Commit 9dcc2a3

Browse files
add links and images to getting started
1 parent 898240d commit 9dcc2a3

File tree

7 files changed

+45
-24
lines changed

7 files changed

+45
-24
lines changed

doc/getting-started/index.rst

Lines changed: 45 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -25,60 +25,81 @@ You are good to go!
2525
.. dropdown:: How does CLIMADA compute impacts ?
2626
:color: primary
2727

28-
CLIMADA computes impacts following the IPCC risk framework by combining hazard intensity, exposure, and vulnerability
29-
data. It models hazards intensity (e.g., tropical cyclones, floods) using
28+
CLIMADA follows the IPCC risk framework to compute impacts by combining hazard intensity, exposure, and vulnerability.
29+
It models hazards intensity (e.g., tropical cyclones, floods) using
3030
historical event sets or stochastic simulations, overlaying them with spatial exposure data
31-
(e.g., population, infrastructure), and applies vulnerability functions that estimate damage or
32-
loss, given the hazard intensity. By aggregating these results, CLIMADA calculates expected
33-
impacts, such as economic losses or affected populations.
31+
(e.g., population, infrastructure), and applies vulnerability functions that estimate damage
32+
given the hazard intensity. By aggregating these results, CLIMADA calculates expected
33+
impacts, such as economic losses or affected populations. See the dedicated :doc:`impact tutorial </user-guide/climada_engine_Impact>`
34+
for more informations.
35+
36+
.. image:: /user-guide/img/risk_framework.png
37+
:width: 400
38+
:alt: Alternative text
39+
:align: center
40+
3441
.. dropdown:: How do you create a Hazard ?
3542
:color: primary
3643

3744
From a risk perspective, the intersting aspect of a natural hazard is its location and intensity. For such,
38-
CLIMADA allows you to load your own hazard data or to directly define it using the platform. As an example,
39-
Users can easily load historical tropical cyclone tracks (IBTracks) and apply stochastic methods to generate
40-
a larger ensemble of tracks from the historical ones, from which they can easily compute the maximal windspeed.
45+
CLIMADA allows you to load your own :doc:`hazard </user-guide/climada_hazard_Hazard>` data or to directly define it in the platform. As an example,
46+
users can easily load historical tropical cyclone tracks (IBTracks) and apply stochastic methods to generate
47+
a larger ensemble of tracks from the historical ones, from which they can easily compute the maximal windspeed,
48+
the hazard intensity.
49+
50+
.. image:: /user-guide/img/tc-tracks.png
51+
:width: 500
52+
:alt: Alternative text
53+
:align: center
4154

4255
.. dropdown:: How do we define an exposure ?
4356
:color: primary
4457

4558
Exposure is defined as the entity that could potentially be damaged by a hazard: it can be people, infrastructures,
46-
assests, ecosystems or others. The CLIMADA user is given the option to load its own exposure data into the platform,
47-
or to use CLIMADA to define it. One common way of defining assets' exposure is through LitPop (link). LitPop dissagrate a
48-
financial index, as the GDP of a country for instance, to a much finer resolution proportionally to population
59+
assests, ecosystems or more. A CLIMADA user is given the option to load its own exposure data into the platform,
60+
or to use CLIMADA to define it. One common way of defining assets' exposure is through :doc:`LitPop </user-guide/climada_entity_LitPop>`. LitPop dissagrate a
61+
financial index, as the country GDP for instance, to a much finer resolution proportionally to population
4962
density and nighlight intensity.
5063

51-
.. dropdown:: What are centroids ?
52-
:color: primary
53-
54-
How can you compute the impact of a hazard on an exposure if their locations differs ? Well, you can't.
55-
This is what cetroids are for. Centroids are a grid of points defined by the users, in which both the exposure value
56-
and hazard intensity are calculated, allowing you to obtain the asset value and the hazard intensity im those
57-
defined points.
64+
.. image:: /user-guide/img/exposure.png
65+
:width: 500
66+
:align: center
5867

5968
.. dropdown:: How do we model vulnerability ?
6069
:color: primary
6170

6271
Vulnerability curves, also known as impact functions, tie the link between hazard intensity and damage.
63-
CLIMADA offers built-in sigmoidal or step-wise vulnerability curves, or allows you to calibrate your own
64-
impact functions with damage and hazard data through the calibration module (link).
72+
CLIMADA offers built-in sigmoidal or step-wise vulnerability curves, and allows you to calibrate your own
73+
impact functions with damage and hazard data through the :doc:`calibration module </user-guide/climada_util_calibrate>`.
74+
6575

66-
(image many impact functions and optimal)
76+
.. image:: /user-guide/img/impact-function.png
77+
:width: 400
78+
:align: center
6779

68-
.. dropdown:: Do you want to quantify the uncertainties ?
80+
.. dropdown:: Do you want to quantify uncertainties ?
6981
:color: primary
7082

71-
CLIMADA provides a dedicated module ([unsequa link]) for conducting uncertainty and sensitivity analyses.
83+
CLIMADA provides a dedicated module :doc:`unsequa </user-guide/climada_engine_unsequa>` for conducting uncertainty and sensitivity analyses.
7284
This module allows you to define a range of input parameters and evaluate their influence on the output,
7385
helping you quantify the sensitivity of the modeling chain as well as the uncertainties in your results.
7486

87+
.. image:: /user-guide/img/sensitivity.png
88+
:width: 500
89+
:align: center
90+
7591
.. dropdown:: Compare adaptation measures and assess their cost-effectiveness
7692
:color: primary
7793

7894
Is there an adaptation measure that will decrease the impact? Does the cost needed to implement such
79-
measure outweight the gains? All these questions can be asnwered using the cost-benefit module (link adaptation).
95+
measure outweight the gains? All these questions can be asnwered using the :doc:`cost-benefit </user-guide/climada_engine_CostBenefit>` and
96+
:doc:`adaptation module </user-guide/climada_entity_MeasureSet>`.
8097
With this module, users can define and compare adaptation measures to establish their cost-effectiveness.
8198

99+
.. image:: /user-guide/img/cost-benefit.png
100+
:width: 400
101+
:align: center
102+
82103
.. toctree::
83104
:maxdepth: 1
84105
:hidden:
18.3 KB
Loading

doc/user-guide/img/exposure.png

168 KB
Loading
84 KB
Loading
469 KB
Loading

doc/user-guide/img/sensitivity.png

141 KB
Loading

doc/user-guide/img/tc-tracks.png

67.1 KB
Loading

0 commit comments

Comments
 (0)