Minor documentation improvements and corrections

diff --git a/doc/en/ref_algorithm_3DVAR.rst b/doc/en/ref_algorithm_3DVAR.rst
index 3a6436f37bf15f1dfd43b814cd83decb032c7022..b196e3bbd7f7434ffb217d931572d8abd758e74d 100644 (file)
--- a/doc/en/ref_algorithm_3DVAR.rst
+++ b/doc/en/ref_algorithm_3DVAR.rst
@@ -129,6 +129,7 @@ StoreSupplementaryCalculations
   "MahalanobisConsistency",
   "OMA",
   "OMB",
+  "SampledStateForQuantiles",
   "SigmaObs2",
   "SimulatedObservationAtBackground",
   "SimulatedObservationAtCurrentOptimum",
@@ -206,6 +207,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/OMB.rst
 
+.. include:: snippets/SampledStateForQuantiles.rst
+
 .. include:: snippets/SigmaObs2.rst
 
 .. include:: snippets/SimulatedObservationAtBackground.rst

diff --git a/doc/en/ref_algorithm_Blue.rst b/doc/en/ref_algorithm_Blue.rst
index 6d0668897b17f7070719370c8470e55d43666bfa..11d2c8d11a3ddfc6a6bee21970f8caed0146492a 100644 (file)
--- a/doc/en/ref_algorithm_Blue.rst
+++ b/doc/en/ref_algorithm_Blue.rst
@@ -106,6 +106,7 @@ StoreSupplementaryCalculations
   "MahalanobisConsistency",
   "OMA",
   "OMB",
+  "SampledStateForQuantiles",
   "SigmaBck2",
   "SigmaObs2",
   "SimulatedObservationAtBackground",
@@ -162,6 +163,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/OMB.rst
 
+.. include:: snippets/SampledStateForQuantiles.rst
+
 .. include:: snippets/SigmaBck2.rst
 
 .. include:: snippets/SigmaObs2.rst

diff --git a/doc/en/ref_algorithm_ExtendedBlue.rst b/doc/en/ref_algorithm_ExtendedBlue.rst
index d02eab739fb289152e6b274010414d7abe879676..eb9b9a8483bad2b3cedc117984b6e4fde988c6d0 100644 (file)
--- a/doc/en/ref_algorithm_ExtendedBlue.rst
+++ b/doc/en/ref_algorithm_ExtendedBlue.rst
@@ -92,6 +92,7 @@ StoreSupplementaryCalculations
   "MahalanobisConsistency",
   "OMA",
   "OMB",
+  "SampledStateForQuantiles",
   "SigmaBck2",
   "SigmaObs2",
   "SimulatedObservationAtBackground",
@@ -148,6 +149,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/OMB.rst
 
+.. include:: snippets/SampledStateForQuantiles.rst
+
 .. include:: snippets/SigmaBck2.rst
 
 .. include:: snippets/SigmaObs2.rst

diff --git a/doc/en/snippets/SampledStateForQuantiles.rst b/doc/en/snippets/SampledStateForQuantiles.rst
new file mode 100644 (file)
index 0000000..c571e59
--- /dev/null
+++ b/doc/en/snippets/SampledStateForQuantiles.rst
@@ -0,0 +1,10 @@
+.. index:: single: SampledStateForQuantiles
+
+SampledStateForQuantiles
+  *List of vector series*. Each element is a series of column state vectors,
+  generated to estimate by simulation and/or observation the quantile values
+  required by the user. There are as many states as the number of samples
+  required for this quantile estimate.
+
+  Example :
+  ``Xq = ADD.get("SampledStateForQuantiles")[:]``

diff --git a/doc/en/snippets/SimulatedObservationAtOptimum.rst b/doc/en/snippets/SimulatedObservationAtOptimum.rst
index 9015483b24e0c51ec3b459a6e9aab1b95163aea8..3b8434d74ea7a2d723934a4b9256583c107978bc 100644 (file)
--- a/doc/en/snippets/SimulatedObservationAtOptimum.rst
+++ b/doc/en/snippets/SimulatedObservationAtOptimum.rst
@@ -3,9 +3,9 @@
 
 SimulatedObservationAtOptimum
   *List of vectors*. Each element is a vector of observation obtained by the
-  observation operator from the analysis or optimal state :math:`\mathbf{x}^a`.
-  It is the observed forecast from the analysis or the optimal state, and it is
-  sometimes called "*Forecast*".
+  observation operator from simulation on the analysis or optimal state
+  :math:`\mathbf{x}^a`. It is the observed forecast from the analysis or the
+  optimal state, and it is sometimes called "*Forecast*".
 
   Example:
   ``hxa = ADD.get("SimulatedObservationAtOptimum")[-1]``

diff --git a/doc/en/snippets/SimulationQuantiles.rst b/doc/en/snippets/SimulationQuantiles.rst
index da7132d55bda6b289f9f577a1fbe618d4a2a7ed9..631af119e38045280d31fc5cd00a58a7c8d58402 100644 (file)
--- a/doc/en/snippets/SimulationQuantiles.rst
+++ b/doc/en/snippets/SimulationQuantiles.rst
@@ -1,9 +1,11 @@
 .. index:: single: SimulationQuantiles
 
 SimulationQuantiles
-  *List of vectors*. Each element is a vector corresponding to the observed
-  state which realize the required quantile, in the same order than the
-  quantiles values required by the user.
+  *List of vector series*. Each element is a series of observation column
+  vectors, corresponding, for a particular quantile required by the user, to
+  the observed state that achieves the requested quantile. Each observation
+  column vector is rendered in the same order as the quantile values required
+  by the user.
 
   Example:
   ``sQuantiles = ADD.get("SimulationQuantiles")[:]``

diff --git a/doc/fr/ref_algorithm_3DVAR.rst b/doc/fr/ref_algorithm_3DVAR.rst
index 9824a898c8fba75e0519c19c7bc7b42e20ad2d88..608e32d22ac51aee48cc1477e0db4841dd6ebec5 100644 (file)
--- a/doc/fr/ref_algorithm_3DVAR.rst
+++ b/doc/fr/ref_algorithm_3DVAR.rst
@@ -132,6 +132,7 @@ StoreSupplementaryCalculations
   "MahalanobisConsistency",
   "OMA",
   "OMB",
+  "SampledStateForQuantiles",
   "SigmaObs2",
   "SimulatedObservationAtBackground",
   "SimulatedObservationAtCurrentOptimum",
@@ -209,6 +210,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/OMB.rst
 
+.. include:: snippets/SampledStateForQuantiles.rst
+
 .. include:: snippets/SigmaObs2.rst
 
 .. include:: snippets/SimulatedObservationAtBackground.rst

diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst
index b9fd910f3c011b9192ca158a2ae15451489757f4..161d1a576e00ca1e13a6eda3a51cb419c3847236 100644 (file)
--- a/doc/fr/ref_algorithm_Blue.rst
+++ b/doc/fr/ref_algorithm_Blue.rst
@@ -108,6 +108,7 @@ StoreSupplementaryCalculations
   "MahalanobisConsistency",
   "OMA",
   "OMB",
+  "SampledStateForQuantiles",
   "SigmaBck2",
   "SigmaObs2",
   "SimulatedObservationAtBackground",
@@ -164,6 +165,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/OMB.rst
 
+.. include:: snippets/SampledStateForQuantiles.rst
+
 .. include:: snippets/SigmaBck2.rst
 
 .. include:: snippets/SigmaObs2.rst

diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst
index ff84246054294bab6ee3668afe9db3444f7d4fad..b40211cf152a44e2add15316f18c2ecee6a51515 100644 (file)
--- a/doc/fr/ref_algorithm_ExtendedBlue.rst
+++ b/doc/fr/ref_algorithm_ExtendedBlue.rst
@@ -93,6 +93,7 @@ StoreSupplementaryCalculations
   "MahalanobisConsistency",
   "OMA",
   "OMB",
+  "SampledStateForQuantiles",
   "SigmaBck2",
   "SigmaObs2",
   "SimulatedObservationAtBackground",
@@ -149,6 +150,8 @@ StoreSupplementaryCalculations
 
 .. include:: snippets/OMB.rst
 
+.. include:: snippets/SampledStateForQuantiles.rst
+
 .. include:: snippets/SigmaBck2.rst
 
 .. include:: snippets/SigmaObs2.rst

diff --git a/doc/fr/snippets/SampledStateForQuantiles.rst b/doc/fr/snippets/SampledStateForQuantiles.rst
new file mode 100644 (file)
index 0000000..b2226ec
--- /dev/null
+++ b/doc/fr/snippets/SampledStateForQuantiles.rst
@@ -0,0 +1,10 @@
+.. index:: single: SampledStateForQuantiles
+
+SampledStateForQuantiles
+  *Liste de séries de vecteurs*. Chaque élément est une série de vecteurs
+  d'état colonnes, généré pour estimer par simulation et/ou observation les
+  valeurs de quantiles requis par l'utilisateur. Il y a autant d'états que le
+  nombre d'échantillons requis pour cette estimation de quantiles.
+
+  Exemple :
+  ``Xq = ADD.get("SampledStateForQuantiles")[:]``

diff --git a/doc/fr/snippets/SimulatedObservationAtOptimum.rst b/doc/fr/snippets/SimulatedObservationAtOptimum.rst
index d7bc73b2c795404892b16edca76b656d4163c435..42ec3265ea0b4b2c00c800d29e95bb6d48f644d1 100644 (file)
--- a/doc/fr/snippets/SimulatedObservationAtOptimum.rst
+++ b/doc/fr/snippets/SimulatedObservationAtOptimum.rst
@@ -3,8 +3,8 @@
 
 SimulatedObservationAtOptimum
   *Liste de vecteurs*. Chaque élément est un vecteur d'observation obtenu par
-  l'opérateur d'observation à partir de l'analyse ou de l'état optimal
-  :math:`\mathbf{x}^a`. C'est l'observation de la prévision à partir de
+  l'opérateur d'observation à partir de la simulation d'analyse ou d'état
+  optimal :math:`\mathbf{x}^a`. C'est l'observation de la prévision à partir de
   l'analyse ou de l'état optimal, et elle est parfois appellée "*Forecast*".
 
   Exemple :

diff --git a/doc/fr/snippets/SimulationQuantiles.rst b/doc/fr/snippets/SimulationQuantiles.rst
index b701034e29b0b7e9b2149b86e07b9c33cb3a914a..68b4b7b82becdc99a18a1a4ff3f23cc3b4732143 100644 (file)
--- a/doc/fr/snippets/SimulationQuantiles.rst
+++ b/doc/fr/snippets/SimulationQuantiles.rst
@@ -1,8 +1,10 @@
 .. index:: single: SimulationQuantiles
 
 SimulationQuantiles
-  *Liste de vecteurs*. Chaque élément est un vecteur correspondant à l'état
-  observé qui réalise le quantile demandé, dans le même ordre que les valeurs
+  *Liste de séries de vecteurs*. Chaque élément est une série de vecteurs
+  colonnes d'observation, correspondant, pour un quantile particulier requis
+  par l'utilisateur, à l'état observé qui réalise le quantile demandé. Chaque
+  vecteur colonne d'observation est restitué dans le même ordre que les valeurs
   de quantiles requis par l'utilisateur.
 
   Exemple :