From c5b4fce215b5a781d00955618ce3019fa6d4f7a0 Mon Sep 17 00:00:00 2001 From: Patrick Date: Tue, 23 Aug 2022 14:53:05 +0200 Subject: [PATCH] added dynamic spinup and dynamic mu star calibration to docs and API reference --- docs/api.rst | 2 ++ docs/dynamic-spinup.rst | 15 +++++++++++++++ docs/index.rst | 2 ++ oggm/core/dynamic_spinup.py | 6 +++--- 4 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/dynamic-spinup.rst diff --git a/docs/api.rst b/docs/api.rst index b3fcaa48c..adf844164 100644 --- 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 new file mode 100644 index 000000000..30148fc9e --- /dev/null +++ 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 `_ +if you are interested and would like to learn more about these tasks. diff --git a/docs/index.rst b/docs/index.rst index 4e18d574b..0a25b0448 100644 --- 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 index d952527fd..9eada4c39 100644 --- 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