Skip to content

Commit 458d672

Browse files
committed
Integrate tutorial into doc toctree
1 parent 7a8d3dd commit 458d672

3 files changed

Lines changed: 21 additions & 2 deletions

File tree

doc/user-guide/climada_engine_Forecast.ipynb

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55
"metadata": {},
66
"source": [
77
"# Forecast class\n",
8+
"\n",
9+
"```{warning}\n",
10+
"\n",
11+
"The standalone `Forecast` class has been superseded by the implementations of {py:class}`~climada.hazard.forecast.HazardForecast` and {py:class}`~climada.engine.impact_forecast.ImpactForecast`.\n",
12+
"Their usage is explained in [another tutorial](climada_engine_ImpactForecast.ipynb).\n",
13+
"```\n",
14+
"\n",
815
"This class deals with weather forecasts and uses CLIMADA ImpactCalc.impact() to forecast impacts of weather events on society. It mainly does one thing:\n",
916
"- it contains all plotting and other functionality that are specific for weather forecasts, impact forecasts and warnings\n",
1017
"\n",

doc/user-guide/climada_engine_ImpactForecast.ipynb

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"source": [
88
"# Hazard forecasts and impacts forecasts\n",
99
"\n",
10-
"In this tutorial, we showcase CLIMADA functionality to handle forecast data using the classes `HazardForecast` and `ImpactForecast`.\n"
10+
"In this tutorial, we showcase CLIMADA functionality to handle forecast data using the classes {py:class}`~climada.hazard.forecast.HazardForecast` and {py:class}`~climada.engine.impact_forecast.ImpactForecast`.\n",
11+
"Exemplary forecast data will be downloaded from the Open Government Data (OGD) portal of MeteoSwiss."
1112
]
1213
},
1314
{
@@ -92,6 +93,16 @@
9293
"\n"
9394
]
9495
},
96+
{
97+
"cell_type": "code",
98+
"execution_count": null,
99+
"id": "0678c808",
100+
"metadata": {},
101+
"outputs": [],
102+
"source": [
103+
"!pip install meteodata-lab"
104+
]
105+
},
95106
{
96107
"cell_type": "code",
97108
"execution_count": 4,

doc/user-guide/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ You can then go on to more specific tutorial about `Hazard <hazard>`_,
2121
Impact <impact>
2222
Local exceedance intensities <climada_util_local_exceedance_values>
2323
Uncertainty Quantification <unsequa>
24-
climada_engine_Forecast
24+
Forecasts <climada_engine_ImpactForecast>
2525
climada_util_calibrate
2626
Google Earth Engine <climada_util_earth_engine>
2727
climada_util_api_client
28+
Forecast class (outdated) <climada_engine_Forecast>
2829
How to cite CLIMADA <../misc/citation>

0 commit comments

Comments
 (0)