]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation corrections
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Tue, 4 May 2021 13:53:25 +0000 (15:53 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Tue, 4 May 2021 13:53:25 +0000 (15:53 +0200)
doc/en/ref_algorithm_EnsembleKalmanFilter.rst
doc/en/snippets/Header2Algo00.rst
doc/fr/ref_algorithm_EnsembleKalmanFilter.rst
doc/fr/snippets/Header2Algo00.rst

index 78d3b749d6d621afd8a5cc141c30f2fac63d18e4..097963ddebe359647dbdd1d6057f543b99331388 100644 (file)
@@ -27,6 +27,9 @@
 Calculation algorithm "*EnsembleKalmanFilter*"
 ----------------------------------------------
 
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo00.rst
+
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo01.rst
 
@@ -52,7 +55,8 @@ In case of linear of "slightly" non-linear operators, one can easily use the
 to evaluate on small systems. One can verify the linearity of the operators
 with the help of the :ref:`section_ref_algorithm_LinearityTest`.
 
-There exists a lot of variants of this algorithm. The following stable and robust formulations are proposed here:
+There exists a lot of variants of this algorithm. The following stable and
+robust formulations are proposed here:
 
 .. index::
     pair: Variant ; EnKF
@@ -67,7 +71,9 @@ There exists a lot of variants of this algorithm. The following stable and robus
 - "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.
 
-Without being a universal recommandation, one recommend to use EnKF as a reference algorithm, and the other algorithms (in this order) as means to obtain less costly data assimilation with hopefully the same quality.
+Without being a universal recommandation, one recommend to use "EnKF" as a
+reference algorithm, and the other algorithms (in this order) as means to
+obtain less costly data assimilation with hopefully the same quality.
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo02.rst
index 7f769cb87c5e6809798d9112cae7c2c0c4132221..98c861aa8c0088b524e1f253e9309f5c27dd2b5c 100644 (file)
@@ -1,4 +1,4 @@
 .. warning::
 
-  in its present version, this algorithm is experimental, and therefore remains
-  subject to changes in future versions.
+   in this particular version, this algorithm or some of its variants are
+   experimental, and therefore remain subject to change in future versions.
index 467f5892474a0ad8d8718853694b7bd2c260f0d6..97679610f31399e34aa1c762cd77923e7171686a 100644 (file)
@@ -27,6 +27,9 @@
 Algorithme de calcul "*EnsembleKalmanFilter*"
 ---------------------------------------------
 
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo00.rst
+
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo01.rst
 
@@ -53,7 +56,8 @@ l':ref:`section_ref_algorithm_KalmanFilter`, qui sont souvent largement moins
 coûteux en évaluations sur de petits systèmes. On peut vérifier la linéarité
 des opérateurs à l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
 
-Il existe de nombreuses variantes de cet algorithme. On propose ici des formulations stables et robustes suivantes :
+Il existe de nombreuses variantes de cet algorithme. On propose ici des
+formulations stables et robustes suivantes :
 
 .. index::
     pair: Variant ; EnKF
@@ -68,7 +72,10 @@ Il existe de nombreuses variantes de cet algorithme. On propose ici des formulat
 - "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.
 
-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 obtenir une assimilation de données plus économique et de qualité éventuellement similaire.
+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
+obtenir une assimilation de données plus économique et de qualité
+éventuellement similaire.
 
 .. ------------------------------------ ..
 .. include:: snippets/Header2Algo02.rst
index 5dbd5ef51018fd49e36b54f0b74a3f6251cbdc18..4ddba6b3f523139cce5116f315bde9bf7b4a76d0 100644 (file)
@@ -1,4 +1,5 @@
 .. warning::
 
-  dans sa présente version, cet algorithme est expérimental, et reste donc
-  susceptible de changements dans les prochaines versions.
+  dans la présente version, cet algorithme ou certaines de ses variantes sont
+  expérimentaux, et restent donc susceptibles de changements dans les
+  prochaines versions.