From d4d8d11e6f4bb1cde8bf0e9acad4e76427244614 Mon Sep 17 00:00:00 2001 From: Helen Kershaw Date: Fri, 9 Aug 2024 14:24:33 -0400 Subject: [PATCH 1/2] doc: remove out-of-date info about inflation flavor character strings link to inflation page rather than "program filter" which does not have any inflation info. --- .../modules/assimilation/filter_mod.rst | 39 ++----------------- guide/inflation.rst | 2 + 2 files changed, 5 insertions(+), 36 deletions(-) diff --git a/assimilation_code/modules/assimilation/filter_mod.rst b/assimilation_code/modules/assimilation/filter_mod.rst index d0b0940494..490753f116 100644 --- a/assimilation_code/modules/assimilation/filter_mod.rst +++ b/assimilation_code/modules/assimilation/filter_mod.rst @@ -270,11 +270,11 @@ prior inflation and the second controls the posterior inflation. | | | defaults to model timestep size. | +------------------------------+---------------------+-------------------------------------------+ | All variables named inf_* are arrays of length 2. The first element controls the prior, | -| the second element controls the posterior inflation. See :doc:`../../programs/filter/filter` | +| the second element controls the posterior inflation. See :ref:`Inflation` | | for a discussion of inflation and effective strategies. | +------------------------------+---------------------+-------------------------------------------+ -| inf_flavor | character(len=32), | Inflation flavor [prior, posterior] | -| | dimension(2) | see `Inflation Options`_ below. | +| inf_flavor | integer, | Inflation flavor [prior, posterior] | +| | dimension(2) | see :ref:`Inflation` for details | +------------------------------+---------------------+-------------------------------------------+ | inf_initial_from_restart | logical, | If ``.true.``, get initial mean values | | | dimension(2) | for inflation from inflation file. | @@ -407,39 +407,6 @@ prior inflation and the second controls the posterior inflation. | | | volume of output. | +------------------------------+---------------------+-------------------------------------------+ -Inflation Options ------------------ - -The value for the ``inf_flavor`` is a character string. For backwards compatiblity -(it was an integer code), the specification of the integer is still supported. -Inflation values (for flavors other than 0) will be time-varying -only if ``inf_sd_initial`` > 0. - -+--------------------------------+---------------------------------------------------------+ -| inflation option | description | -+================================+=========================================================+ -| | 0 | no inflation | -| | '0' | | -| | 'NO_INFLATION' | | -+--------------------------------+---------------------------------------------------------+ -| | 2 | spatially-varying state-space (gaussian) | -| | '2' | | -| | 'VARYING_SS_INFLATION' | | -+--------------------------------+---------------------------------------------------------+ -| | 3 | spatially-fixed state-space (gaussian) | -| | '3' | | -| | 'SINGLE_SS_INFLATION' | | -+--------------------------------+---------------------------------------------------------+ -| | 4 | Relaxation To Prior Spread (Posterior inflation only) | -| | '4' | | -| | 'RELAXATION_TO_PRIOR_SPREAD' | | -| | 'RTPS | | -+--------------------------------+---------------------------------------------------------+ -| | 5 | Enhanced spatially-varying state-space (inverse gamma). | -| | '5' | Refer to ``inf_sd_initial`` for how to set the | -| | 'ENHANCED_SS_INFLATION' | time evolution options. | -+--------------------------------+---------------------------------------------------------+ - .. _pert_model_copies: diff --git a/guide/inflation.rst b/guide/inflation.rst index e26e09672d..2043507da1 100644 --- a/guide/inflation.rst +++ b/guide/inflation.rst @@ -1,3 +1,5 @@ +.. _inflation: + Inflation ========= From 0e04d6715ecdc13d256c7c19223f610125a32ee1 Mon Sep 17 00:00:00 2001 From: Helen Kershaw Date: Wed, 28 Aug 2024 09:54:34 -0400 Subject: [PATCH 2/2] doc-fix: inflation error codes https://github.com/NCAR/DART/pull/715#pullrequestreview-2264709392 --- assimilation_code/modules/assimilation/filter_mod.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assimilation_code/modules/assimilation/filter_mod.rst b/assimilation_code/modules/assimilation/filter_mod.rst index 490753f116..ca9e2630af 100644 --- a/assimilation_code/modules/assimilation/filter_mod.rst +++ b/assimilation_code/modules/assimilation/filter_mod.rst @@ -463,7 +463,7 @@ Error codes and conditions +================================+=======================================================================+==================================================================+ | filter_main | ens_size in namelist is ###: Must be > 1 | Ensemble size must be at least 2. | +--------------------------------+-----------------------------------------------------------------------+------------------------------------------------------------------+ -| filter_main | inf_flavor= ### Must be 0, 2, 3. | Observation Inflation is no longer supported (i.e flavor 1). | +| filter_main | inf_flavor = ### Must be 0, 2, 3, 4, 5 | Observation Inflation is no longer supported (i.e flavor 1). | +--------------------------------+-----------------------------------------------------------------------+------------------------------------------------------------------+ | filter_main | Posterior observation space inflation (type 1) not supported. | Posterior observation space inflation doesn't work. | +--------------------------------+-----------------------------------------------------------------------+------------------------------------------------------------------+