Skip to content

Commit dd804b7

Browse files
committed
Adds future documentation placeholders, warnings in legacy guides
1 parent 254a605 commit dd804b7

4 files changed

Lines changed: 32 additions & 4 deletions

File tree

doc/user-guide/adaptation.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
==========================
2+
Adapation appraisal guides
3+
==========================
4+
5+
These guides show everything you need to know in order to evaluate adapation options with CLIMADA.
6+
7+
.. toctree::
8+
:maxdepth: 1
9+
10+
.. Adaptation measures in CLIMADA <climada_measures.ipynb>
11+
Using measure configurations <climada_measure_config.ipynb>
12+
.. Defining measure cash flows <climada_cost_income.ipynb>
13+
.. Cost benefit evaluation <climada_cost_benefit.ipynb>
14+
.. Adapation planning evaluation <climada_planning_evaluation.ipynb>

doc/user-guide/climada_engine_CostBenefit.ipynb

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77
"# END-TO-END COST BENEFIT CALCULATION"
88
]
99
},
10+
{
11+
"cell_type": "markdown",
12+
"metadata": {},
13+
"source": [
14+
"```{attention}\n",
15+
"Adapation measures and cost-benefit evaluation are being completely revamped. Associated tutorials will be under their own menu \"Adaptation appraisal guides\"\n",
16+
"```"
17+
]
18+
},
1019
{
1120
"attachments": {},
1221
"cell_type": "markdown",
@@ -1286,9 +1295,9 @@
12861295
],
12871296
"metadata": {
12881297
"kernelspec": {
1289-
"display_name": "Python 3 (ipykernel)",
1298+
"display_name": "Python [conda env:climada_env_dev]",
12901299
"language": "python",
1291-
"name": "python3"
1300+
"name": "conda-env-climada_env_dev-py"
12921301
},
12931302
"language_info": {
12941303
"codemirror_mode": {
@@ -1300,7 +1309,7 @@
13001309
"name": "python",
13011310
"nbconvert_exporter": "python",
13021311
"pygments_lexer": "ipython3",
1303-
"version": "3.8.10"
1312+
"version": "3.11.15"
13041313
},
13051314
"latex_envs": {
13061315
"LaTeX_envs_menu_present": true,

doc/user-guide/climada_entity_MeasureSet.ipynb

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66
"source": [
77
"# Adaptation Measures\n",
88
"\n",
9-
"Adaptation measures are defined by parameters that alter the exposures, hazard or impact functions. Risk transfer options are also considered. Single measures are defined in the `Measure` class, which can be aggregated to a `MeasureSet`."
9+
"Adaptation measures are defined by parameters that alter the exposures, hazard or impact functions. Risk transfer options are also considered. Single measures are defined in the `Measure` class, which can be aggregated to a `MeasureSet`.\n",
10+
"\n",
11+
"```{attention}\n",
12+
"Adapation measures and cost-benefit evaluation are being completely revamped. Associated tutorials will be under their own menu \"Adaptation appraisal guides\".\n",
13+
"```"
1014
]
1115
},
1216
{

doc/user-guide/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ You can then go on to more specific tutorial about `Hazard <hazard.html>`_,
1919
Hazard <hazard>
2020
Exposures <exposures>
2121
Impact <impact>
22+
Adaptation appraisal <adaptation>
2223
Local exceedance intensities <climada_util_local_exceedance_values>
2324
Uncertainty Quantification <unsequa>
2425
climada_engine_Forecast

0 commit comments

Comments
 (0)