added dynamic spinup and dynamic mu star calibration to docs and API …

…reference
OGGM · Aug 23, 2022 · c5b4fce · c5b4fce
1 parent 3a4e8a3
commit c5b4fce
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 3 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -164,6 +164,8 @@ the majority of OGGM's tasks). They are parallelizable.
     tasks.run_random_climate
     tasks.run_from_climate_data
     tasks.run_constant_climate
+    tasks.run_dynamic_spinup
+    tasks.run_dynamic_mu_star_calibration
     tasks.copy_to_basedir
     tasks.gdir_to_tar
 

diff --git a/docs/dynamic-spinup.rst b/docs/dynamic-spinup.rst
@@ -0,0 +1,15 @@
+Dynamic spinup
+==============
+
+OGGM offers an option for reconstructing the recent past of a glacier by using
+a dynamic spinup. For this dynamic spinup, you can choose if you want to match
+area OR volume at the RGI-date.
+
+Further, this dynamic spinup can be combined
+with a dynamic :math:`\mu ^{*}` calibration. This calibration also tries to
+calibrate :math:`\mu ^{*}` to match geodetic MB data as it is described in
+:doc:`mass-balance-2012-pergla`, but further takes a dynamically changing glacier
+geometry into account.
+
+Visit our `tutorials <https://oggm.org/tutorials>`_
+if you are interested and would like to learn more about these tasks.
diff --git a/docs/index.rst b/docs/index.rst
@@ -43,6 +43,7 @@ Core principles and structure of the OGGM modelling framework.
 * :doc:`geometry-evolution`
 * :doc:`inversion`
 * :doc:`frontal-ablation`
+* :doc:`dynamic-spinup`
 
 .. toctree::
     :maxdepth: 1
@@ -56,6 +57,7 @@ Core principles and structure of the OGGM modelling framework.
     geometry-evolution.rst
     inversion.rst
     frontal-ablation.rst
+    dynamic-spinup.rst
 
 Using OGGM
 ^^^^^^^^^^

diff --git a/oggm/core/dynamic_spinup.py b/oggm/core/dynamic_spinup.py
@@ -66,13 +66,13 @@ def run_dynamic_spinup(gdir, init_model_filesuffix=None, init_model_yr=None,
         Ignored if `init_model_filesuffix` is set
     climate_input_filesuffix : str
         filesuffix for the input climate file
-    evolution_model : :class:oggm.core.FlowlineModel
+    evolution_model : :class:`oggm.core.FlowlineModel`
         which evolution model to use. Default: FluxBasedModel
-    mb_model_historical : :py:class:`core.MassBalanceModel`
+    mb_model_historical : :py:class:`oggm.core.MassBalanceModel`
         User-povided MassBalanceModel instance for the historical run. Default
         is to use a PastMassBalance model  together with the provided
         parameter climate_input_filesuffix.
-    mb_model_spinup : :py:class:`core.MassBalanceModel`
+    mb_model_spinup : :py:class:`oggm.core.MassBalanceModel`
         User-povided MassBalanceModel instance for the spinup before the
         historical run. Default is to use a ConstantMassBalance model together
         with the provided parameter climate_input_filesuffix and during the