Skip to content

Commit 3d94151

Browse files
committed
Add tutorial on impact function calibration
1 parent e8abb1a commit 3d94151

File tree

4 files changed

+3075
-3
lines changed

4 files changed

+3075
-3
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
==================================
2+
Impact Function Calibration Module
3+
==================================
4+
5+
Base Classes
6+
------------
7+
8+
Generic classes for defining the data structures of this module.
9+
10+
.. automodule:: climada.util.calibrate.base
11+
:members:
12+
:private-members:
13+
14+
Bayesian Optimizer
15+
------------------
16+
17+
Calibration based on Bayesian optimization.
18+
19+
.. automodule:: climada.util.calibrate.bayesian_optimizer
20+
:members:
21+
:show-inheritance:
22+
:inherited-members: abc.ABC
23+
24+
Scipy Optimizer
25+
---------------
26+
27+
Calibration based on the ``scipy.optimize`` module.
28+
29+
.. automodule:: climada.util.calibrate.scipy_optimizer
30+
:members:
31+
:show-inheritance:
32+
:inherited-members: abc.ABC

doc/climada/climada.util.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ climada\.util\.api\_client module
1212
climada\.util\.calibrate module
1313
-------------------------------
1414

15-
.. automodule:: climada.util.calibrate.impact_func
16-
:members:
17-
:show-inheritance:
15+
.. toctree::
16+
:maxdepth: 1
17+
18+
climada.util.calibrate
1819

1920
climada\.util\.checker module
2021
-----------------------------

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Jump right in:
8383
Impact <tutorial/impact>
8484
Uncertainty Quantification <tutorial/unsequa>
8585
tutorial/climada_engine_Forecast
86+
tutorial/climada_util_calibrate
8687
Google Earth Engine <tutorial/climada_util_earth_engine>
8788
tutorial/climada_util_api_client
8889

0 commit comments

Comments
 (0)