From 3e4890c9171e776b943ab57b1515b92852d3388d Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Mon, 28 Jul 2014 23:51:07 +0200 Subject: [PATCH] Documentation minor corrections and improvements --- doc/en/ref_algorithm_3DVAR.rst | 8 ++++---- doc/en/ref_algorithm_Blue.rst | 8 ++++---- doc/en/ref_algorithm_ExtendedBlue.rst | 8 ++++---- doc/en/ref_algorithm_ExtendedKalmanFilter.rst | 6 +++--- doc/en/ref_algorithm_FunctionTest.rst | 6 +++--- doc/en/ref_algorithm_KalmanFilter.rst | 6 +++--- doc/en/ref_algorithm_LinearLeastSquares.rst | 6 +++--- doc/en/ref_algorithm_NonLinearLeastSquares.rst | 6 +++--- doc/en/ref_algorithm_ParticleSwarmOptimization.rst | 6 +++--- doc/en/ref_algorithm_QuantileRegression.rst | 6 +++--- doc/en/ref_algorithm_UnscentedKalmanFilter.rst | 6 +++--- doc/fr/ref_algorithm_3DVAR.rst | 2 +- doc/fr/ref_algorithm_Blue.rst | 9 +++++---- doc/fr/ref_algorithm_ExtendedBlue.rst | 9 +++++---- doc/fr/ref_algorithm_ExtendedKalmanFilter.rst | 7 ++++--- doc/fr/ref_algorithm_KalmanFilter.rst | 7 ++++--- doc/fr/ref_algorithm_LinearLeastSquares.rst | 6 +++--- doc/fr/ref_algorithm_NonLinearLeastSquares.rst | 8 ++++---- doc/fr/ref_algorithm_ParticleSwarmOptimization.rst | 6 +++--- doc/fr/ref_algorithm_QuantileRegression.rst | 6 +++--- doc/fr/ref_algorithm_UnscentedKalmanFilter.rst | 7 ++++--- 21 files changed, 72 insertions(+), 67 deletions(-) diff --git a/doc/en/ref_algorithm_3DVAR.rst b/doc/en/ref_algorithm_3DVAR.rst index cb20894..5d3f73a 100644 --- a/doc/en/ref_algorithm_3DVAR.rst +++ b/doc/en/ref_algorithm_3DVAR.rst @@ -150,10 +150,10 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["APosterioriCovariance", "BMA", "OMA", "OMB", "Innovation", - "SigmaObs2", "MahalanobisConsistency"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["APosterioriCovariance", "BMA", "OMA", "OMB", + "Innovation", "SigmaObs2", "MahalanobisConsistency"]. See also ++++++++ diff --git a/doc/en/ref_algorithm_Blue.rst b/doc/en/ref_algorithm_Blue.rst index 231238d..2ccead4 100644 --- a/doc/en/ref_algorithm_Blue.rst +++ b/doc/en/ref_algorithm_Blue.rst @@ -107,10 +107,10 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["APosterioriCovariance", "BMA", "OMA", "OMB", "Innovation", - "SigmaBck2", "SigmaObs2", "MahalanobisConsistency"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["APosterioriCovariance", "BMA", "OMA", "OMB", + "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency"]. See also ++++++++ diff --git a/doc/en/ref_algorithm_ExtendedBlue.rst b/doc/en/ref_algorithm_ExtendedBlue.rst index 3086e42..3df0b59 100644 --- a/doc/en/ref_algorithm_ExtendedBlue.rst +++ b/doc/en/ref_algorithm_ExtendedBlue.rst @@ -105,10 +105,10 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["APosterioriCovariance", "BMA", "OMA", "OMB", "Innovation", - "SigmaBck2", "SigmaObs2", "MahalanobisConsistency"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["APosterioriCovariance", "BMA", "OMA", "OMB", + "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency"]. See also ++++++++ diff --git a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst index 549cb91..fb8404e 100644 --- a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst @@ -115,9 +115,9 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["APosterioriCovariance", "BMA", "Innovation"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["APosterioriCovariance", "BMA", "Innovation"]. See also ++++++++ diff --git a/doc/en/ref_algorithm_FunctionTest.rst b/doc/en/ref_algorithm_FunctionTest.rst index 0019ff5..4a88614 100644 --- a/doc/en/ref_algorithm_FunctionTest.rst +++ b/doc/en/ref_algorithm_FunctionTest.rst @@ -64,9 +64,9 @@ following: :math:`\mathbf{y}^o`. Its value is defined as a "*Function*" type object or a "*Matrix*" type one. In the case of "*Function*" type, different functional forms can be used, as described in the section - :ref:`section_ref_operator_requirements`. If there is some control - :math:`U` included in the observation, the operator has to be applied to a - pair :math:`(X,U)`. + :ref:`section_ref_operator_requirements`. If there is some control :math:`U` + included in the observation, the operator has to be applied to a pair + :math:`(X,U)`. The general optional commands, available in the editing user interface, are indicated in :ref:`section_ref_assimilation_keywords`. In particular, the diff --git a/doc/en/ref_algorithm_KalmanFilter.rst b/doc/en/ref_algorithm_KalmanFilter.rst index 7112a91..51f0df6 100644 --- a/doc/en/ref_algorithm_KalmanFilter.rst +++ b/doc/en/ref_algorithm_KalmanFilter.rst @@ -112,9 +112,9 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["APosterioriCovariance", "BMA", "Innovation"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["APosterioriCovariance", "BMA", "Innovation"]. See also ++++++++ diff --git a/doc/en/ref_algorithm_LinearLeastSquares.rst b/doc/en/ref_algorithm_LinearLeastSquares.rst index 8d1bbde..ed3c714 100644 --- a/doc/en/ref_algorithm_LinearLeastSquares.rst +++ b/doc/en/ref_algorithm_LinearLeastSquares.rst @@ -96,9 +96,9 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["OMA"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["OMA"]. *Tips for this algorithm:* diff --git a/doc/en/ref_algorithm_NonLinearLeastSquares.rst b/doc/en/ref_algorithm_NonLinearLeastSquares.rst index b9abc19..77e15e8 100644 --- a/doc/en/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/en/ref_algorithm_NonLinearLeastSquares.rst @@ -146,9 +146,9 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["BMA", "OMA", "OMB", "Innovation"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["BMA", "OMA", "OMB", "Innovation"]. *Tips for this algorithm:* diff --git a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst index 3168aff..9979800 100644 --- a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst @@ -148,9 +148,9 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["BMA", "OMA", "OMB", "Innovation"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["BMA", "OMA", "OMB", "Innovation"]. See also ++++++++ diff --git a/doc/en/ref_algorithm_QuantileRegression.rst b/doc/en/ref_algorithm_QuantileRegression.rst index 9a2d989..f27e6a1 100644 --- a/doc/en/ref_algorithm_QuantileRegression.rst +++ b/doc/en/ref_algorithm_QuantileRegression.rst @@ -105,9 +105,9 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["BMA", "OMA", "OMB", "Innovation"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["BMA", "OMA", "OMB", "Innovation"]. *Tips for this algorithm:* diff --git a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst index 9938481..b27c4a5 100644 --- a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst @@ -128,9 +128,9 @@ The options of the algorithm are the following: StoreSupplementaryCalculations This list indicates the names of the supplementary variables that can be available at the end of the algorithm. It involves potentially costly - calculations. The default is a void list, none of these variables being - calculated and stored by default. The possible names are in the following - list: ["APosterioriCovariance", "BMA", "Innovation"]. + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: ["APosterioriCovariance", "BMA", "Innovation"]. See also ++++++++ diff --git a/doc/fr/ref_algorithm_3DVAR.rst b/doc/fr/ref_algorithm_3DVAR.rst index 4b17494..c59df09 100644 --- a/doc/fr/ref_algorithm_3DVAR.rst +++ b/doc/fr/ref_algorithm_3DVAR.rst @@ -156,7 +156,7 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, aucune de ces variables n'étant calculée et stockée par défaut. Les noms possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA", "OMA", "OMB", "Innovation", "SigmaObs2", "MahalanobisConsistency"]. diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst index 96537dc..30391fe 100644 --- a/doc/fr/ref_algorithm_Blue.rst +++ b/doc/fr/ref_algorithm_Blue.rst @@ -110,10 +110,11 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["APosterioriCovariance", "BMA", "OMA", "OMB", - "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA", + "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2", + "MahalanobisConsistency"]. Voir aussi ++++++++++ diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst index 93ffc6d..445126c 100644 --- a/doc/fr/ref_algorithm_ExtendedBlue.rst +++ b/doc/fr/ref_algorithm_ExtendedBlue.rst @@ -107,10 +107,11 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["APosterioriCovariance", "BMA", "OMA", "OMB", - "Innovation", "SigmaBck2", "SigmaObs2", "MahalanobisConsistency"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA", + "OMA", "OMB", "Innovation", "SigmaBck2", "SigmaObs2", + "MahalanobisConsistency"]. Voir aussi ++++++++++ diff --git a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst index bd89b92..6a1c738 100644 --- a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst @@ -119,9 +119,10 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["APosterioriCovariance", "BMA", "Innovation"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA", + "Innovation"]. Voir aussi ++++++++++ diff --git a/doc/fr/ref_algorithm_KalmanFilter.rst b/doc/fr/ref_algorithm_KalmanFilter.rst index b4c4e49..f12940e 100644 --- a/doc/fr/ref_algorithm_KalmanFilter.rst +++ b/doc/fr/ref_algorithm_KalmanFilter.rst @@ -114,9 +114,10 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["APosterioriCovariance", "BMA", "Innovation"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA", + "Innovation"]. Voir aussi ++++++++++ diff --git a/doc/fr/ref_algorithm_LinearLeastSquares.rst b/doc/fr/ref_algorithm_LinearLeastSquares.rst index 9ffd510..ed507fa 100644 --- a/doc/fr/ref_algorithm_LinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_LinearLeastSquares.rst @@ -98,9 +98,9 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["OMA"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["OMA"]. *Astuce pour cet algorithme :* diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst index bb87078..43d8716 100644 --- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst @@ -154,10 +154,10 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["APosterioriCovariance", "BMA", "OMA", "OMB", - "Innovation", "SigmaObs2", "MahalanobisConsistency"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA", + "OMA", "OMB", "Innovation", "SigmaObs2", "MahalanobisConsistency"]. *Astuce pour cet algorithme :* diff --git a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst index 22aacdf..b0ad010 100644 --- a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst @@ -152,9 +152,9 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["BMA", "OMA", "OMB", "Innovation"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["BMA", "OMA", "OMB", "Innovation"]. Voir aussi ++++++++++ diff --git a/doc/fr/ref_algorithm_QuantileRegression.rst b/doc/fr/ref_algorithm_QuantileRegression.rst index 1be544f..3ef9f27 100644 --- a/doc/fr/ref_algorithm_QuantileRegression.rst +++ b/doc/fr/ref_algorithm_QuantileRegression.rst @@ -107,9 +107,9 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["BMA", "OMA", "OMB", "Innovation"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["BMA", "OMA", "OMB", "Innovation"]. *Astuce pour cet algorithme :* diff --git a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst index a3b3b1b..4dd6c53 100644 --- a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst @@ -132,9 +132,10 @@ Les options de l'algorithme sont les suivantes: StoreSupplementaryCalculations Cette liste indique les noms des variables supplémentaires qui peuvent être disponibles à la fin de l'algorithme. Cela implique potentiellement des - calculs coûteux. La valeur par défaut est une liste vide, aucune de ces - variables n'étant calculée et stockée par défaut. Les noms possibles sont - dans la liste suivante : ["APosterioriCovariance", "BMA", "Innovation"]. + calculs ou du stockage coûteux. La valeur par défaut est une liste vide, + aucune de ces variables n'étant calculée et stockée par défaut. Les noms + possibles sont dans la liste suivante : ["APosterioriCovariance", "BMA", + "Innovation"]. Voir aussi ++++++++++ -- 2.39.2