From 14326f349b51e6799e157b4ff38556633626b12a Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Mon, 20 Sep 2021 14:45:56 +0200 Subject: [PATCH] Minor documentation update and corrections --- doc/en/ref_algorithm_EnsembleKalmanFilter.rst | 7 +++++-- doc/en/ref_userpostanalysis_requirements.rst | 3 ++- doc/en/snippets/SmootherLagL.rst | 9 +++++++++ doc/en/snippets/Variant_EnKF.rst | 4 +++- doc/fr/ref_algorithm_EnsembleKalmanFilter.rst | 7 +++++-- doc/fr/ref_userpostanalysis_requirements.rst | 3 ++- doc/fr/snippets/SmootherLagL.rst | 10 ++++++++++ doc/fr/snippets/Variant_EnKF.rst | 4 +++- 8 files changed, 39 insertions(+), 8 deletions(-) create mode 100644 doc/en/snippets/SmootherLagL.rst create mode 100644 doc/fr/snippets/SmootherLagL.rst diff --git a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst index baef174..c4cedef 100644 --- a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst @@ -68,8 +68,9 @@ robust formulations are proposed here: - "EnKF" (Ensemble Kalman Filter, see [Evensen94]_), original stochastic algorithm, allowing consistent treatment of non-linear evolution operator, - "ETKF" (Ensemble-Transform Kalman Filter), deterministic EnKF algorithm, allowing treatment of non-linear evolution operator with a lot less members (one recommends to use a number of members on the order of 10 or even sometimes less), - "ETKF-N" (Ensemble-Transform Kalman Filter of finite size N), ETKF algorithm of "finite size N", yhat doesn't need inflation that is often required with the other algorithms, -- "MLEF" (Maximum Likelihood Kalman Filter, see [Zupanski05]_), deterministic EnKF scheme, allowing in addition the consistent treament of non-linear observation operator, -- "IEnKF" (Iterative EnKF), deterministic EnKF scheme, improving treament of operators non-linearities. +- "MLEF" (Maximum Likelihood Kalman Filter, see [Zupanski05]_), deterministic EnKF algorithm, allowing in addition the consistent treament of non-linear observation operator, +- "IEnKF" (Iterative EnKF), deterministic EnKF algorithm, improving treament of operators non-linearities +- "EnKS" (Ensemble Kalman Smoother), smoothing algorithm with a fixed time lag L. Without being a universal recommandation, one recommend to use "EnKF" as a reference algorithm, and the other algorithms (in this order) as means to @@ -105,6 +106,8 @@ obtain less costly data assimilation with hopefully the same quality. .. include:: snippets/SetSeed.rst +.. include:: snippets/SmootherLagL.rst + StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations diff --git a/doc/en/ref_userpostanalysis_requirements.rst b/doc/en/ref_userpostanalysis_requirements.rst index c37943b..1aa4f0b 100644 --- a/doc/en/ref_userpostanalysis_requirements.rst +++ b/doc/en/ref_userpostanalysis_requirements.rst @@ -91,7 +91,8 @@ A set of post-processing commands is a special Python script, which is automatically activated at the end of the estimation calculations in ADAO. Any Python commands, which a user can add after a TUI calculation in ADAO, can be part of this post-processing. Several command set templates are available by -default. +default,essentially to give the simplest possible example of recording these +series. To be usable in an automatic way, it is required that any call of the ADAO calculation case, to recover a variable, is done only with the reserved name diff --git a/doc/en/snippets/SmootherLagL.rst b/doc/en/snippets/SmootherLagL.rst new file mode 100644 index 0000000..8ed6bfb --- /dev/null +++ b/doc/en/snippets/SmootherLagL.rst @@ -0,0 +1,9 @@ +.. index:: single: SmootherLagL + +SmootherLagL + *Integer value*. This key indicates the number of smoothing time intervals in + the past for the EnKS. This is a number of intervals, not a fixed duration. + The default value is 0, which leads to no smoothing. + + Example : + ``{"SmootherLagL":0}`` diff --git a/doc/en/snippets/Variant_EnKF.rst b/doc/en/snippets/Variant_EnKF.rst index 82a6473..0b1fccc 100644 --- a/doc/en/snippets/Variant_EnKF.rst +++ b/doc/en/snippets/Variant_EnKF.rst @@ -5,6 +5,7 @@ pair: Variant ; ETKF-N pair: Variant ; MLEF pair: Variant ; IEnKF + pair: Variant ; EnKS Variant *Predifined name*. This key allows to choose one of the possible variants @@ -14,7 +15,8 @@ Variant "ETKF" (Ensemble-Transform Kalman Filter), "ETKF-N" (Ensemble-Transform Kalman Filter), "MLEF" (Maximum Likelihood Kalman Filter), - "IEnKF" (Iterative_EnKF). + "IEnKF" (Iterative_EnKF), + "EnKS" (Ensemble Kalman Smoother). One recommends to try the "ETKF-N" or "IEnKF" variants, and to reduce the number of members to about 10 or less for all variants other then the original "EnKF". diff --git a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst index 42fd995..29e3a3d 100644 --- a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst @@ -69,8 +69,9 @@ formulations stables et robustes suivantes : - "EnKF" (Ensemble Kalman Filter, voir [Evensen94]_), algorithme stochastique original, permettant de traiter de manière consistante un opérateur d'évolution non-linéaire, - "ETKF" (Ensemble-Transform Kalman Filter), algorithme déterministe d'EnKF, permettant de traiter un opérateur d'évolution non-linéaire avec beaucoup moins de membres (on recommande d'utiliser un nombre de membres de l'ordre de 10 ou même parfois moins), - "ETKF-N" (Ensemble-Transform Kalman Filter of finite size N), algorithme d'ETKF dit de "taille finie N", évitant de recourir à une inflation souvent nécessaire avec les autres algorithmes, -- "MLEF" (Maximum Likelihood Kalman Filter, voir [Zupanski05]_), schéma déterministe d'EnKF, permettant en plus de traiter de manière consistante un opérateur d'observation non-linéaire), -- "IEnKF" (Iterative EnKF), schéma déterministe d'EnKF, améliorant le traitement des non-linéarités des opérateurs. +- "MLEF" (Maximum Likelihood Kalman Filter, voir [Zupanski05]_), algorithme déterministe d'EnKF, permettant en plus de traiter de manière consistante un opérateur d'observation non-linéaire), +- "IEnKF" (Iterative EnKF), algorithme déterministe d'EnKF, améliorant le traitement des non-linéarités des opérateurs, +- "EnKS" (Ensemble Kalman Smoother), algorithme de lissage avec un décalage fixe. Sans pouvoir prétendre à l'universalité, on recommande d'utiliser l'"EnKF" comme référence, et les autres algorithmes (dans l'ordre) comme des moyens pour @@ -107,6 +108,8 @@ obtenir une assimilation de données plus économique et de qualité .. include:: snippets/SetSeed.rst +.. include:: snippets/SmootherLagL.rst + StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations diff --git a/doc/fr/ref_userpostanalysis_requirements.rst b/doc/fr/ref_userpostanalysis_requirements.rst index 8683b83..fe443ab 100644 --- a/doc/fr/ref_userpostanalysis_requirements.rst +++ b/doc/fr/ref_userpostanalysis_requirements.rst @@ -92,7 +92,8 @@ Une série de commandes de post-traitement est un script Python spécial, qui es automatiquement activée à la fin des calculs d'estimation dans ADAO. Toutes les commandes Python, qu'un utilisateur peut ajouter après un calcul ADAO en interface graphique TUI, peuvent faire partie de ce post-traitement. Plusieurs -modèles de série de commandes sont disponibles par défaut. +modèles de série de commandes sont disponibles par défaut, essentiellement pour +donner un exemple le plus simple possible d'enregistrement de ces séries. Pour être utilisable de manière automatique, il est requis tout appel du cas de calcul ADAO, pour récupérer une variable, se fasse uniquement avec le nom diff --git a/doc/fr/snippets/SmootherLagL.rst b/doc/fr/snippets/SmootherLagL.rst new file mode 100644 index 0000000..fa592ae --- /dev/null +++ b/doc/fr/snippets/SmootherLagL.rst @@ -0,0 +1,10 @@ +.. index:: single: SmootherLagL + +SmootherLagL + *Valeur entière*. Cette clé indique le nombre d'intervalles de temps de + lissage dans le passé pour l'EnKS. C'est bien un nombre d'intervalles, et non + pas une durée fixe. La valeur par défaut est 0, qui conduit à une absence de + lissage. + + Exemple : + ``{"SmootherLagL":0}`` diff --git a/doc/fr/snippets/Variant_EnKF.rst b/doc/fr/snippets/Variant_EnKF.rst index 689c90b..f44b918 100644 --- a/doc/fr/snippets/Variant_EnKF.rst +++ b/doc/fr/snippets/Variant_EnKF.rst @@ -5,6 +5,7 @@ pair: Variant ; ETKF-N pair: Variant ; MLEF pair: Variant ; IEnKF + pair: Variant ; EnKS Variant *Nom prédéfini*. Cette clé permet de choisir l'une des variantes possibles @@ -14,7 +15,8 @@ Variant "ETKF" (Ensemble-Transform Kalman Filter), "ETKF-N" (Ensemble-Transform Kalman Filter), "MLEF" (Maximum Likelihood Kalman Filter), - "IEnKF" (Iterative_EnKF). + "IEnKF" (Iterative_EnKF), + "EnKS" (Ensemble Kalman Smoother). Il est conseillé d'essayer les variantes "ETKF-N" ou "IEnKF", et de réduire le nombre de membres à une dizaine ou moins pour toutes les variantes autres que l'"EnKF" original. -- 2.39.2