From 4004cc7ae597535112efb759ef392254ef5e9b8a Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Tue, 8 Feb 2022 06:57:29 +0100 Subject: [PATCH] Documentation update on some variables --- doc/en/ref_algorithm_Blue.rst | 8 ++++++++ doc/en/ref_algorithm_ExtendedBlue.rst | 8 ++++++++ doc/en/ref_algorithm_LinearLeastSquares.rst | 8 ++++++++ doc/en/ref_algorithm_NonLinearLeastSquares.rst | 8 ++++++++ doc/fr/ref_algorithm_Blue.rst | 8 ++++++++ doc/fr/ref_algorithm_ExtendedBlue.rst | 8 ++++++++ doc/fr/ref_algorithm_LinearLeastSquares.rst | 8 ++++++++ doc/fr/ref_algorithm_NonLinearLeastSquares.rst | 8 ++++++++ 8 files changed, 64 insertions(+) diff --git a/doc/en/ref_algorithm_Blue.rst b/doc/en/ref_algorithm_Blue.rst index d1ec0c4..9c1c156 100644 --- a/doc/en/ref_algorithm_Blue.rst +++ b/doc/en/ref_algorithm_Blue.rst @@ -71,6 +71,8 @@ these reasons, this method is not proposed nor recommended. .. ------------------------------------ .. .. include:: snippets/Header2Algo03AdOp.rst +.. include:: snippets/EstimationOf_Parameters.rst + .. include:: snippets/NumberOfSamplesForQuantiles.rst .. include:: snippets/Quantiles.rst @@ -108,7 +110,9 @@ StoreSupplementaryCalculations "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", + "ForecastState", "Innovation", + "InnovationAtCurrentAnalysis", "MahalanobisConsistency", "OMA", "OMB", @@ -161,8 +165,12 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + .. include:: snippets/Innovation.rst +.. include:: snippets/InnovationAtCurrentAnalysis.rst + .. include:: snippets/MahalanobisConsistency.rst .. include:: snippets/OMA.rst diff --git a/doc/en/ref_algorithm_ExtendedBlue.rst b/doc/en/ref_algorithm_ExtendedBlue.rst index dd8bf6f..7e13e9c 100644 --- a/doc/en/ref_algorithm_ExtendedBlue.rst +++ b/doc/en/ref_algorithm_ExtendedBlue.rst @@ -57,6 +57,8 @@ without being entirely equivalent. .. ------------------------------------ .. .. include:: snippets/Header2Algo03AdOp.rst +.. include:: snippets/EstimationOf_Parameters.rst + .. include:: snippets/NumberOfSamplesForQuantiles.rst .. include:: snippets/Quantiles.rst @@ -94,7 +96,9 @@ StoreSupplementaryCalculations "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", + "ForecastState", "Innovation", + "InnovationAtCurrentAnalysis", "MahalanobisConsistency", "OMA", "OMB", @@ -147,8 +151,12 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + .. include:: snippets/Innovation.rst +.. include:: snippets/InnovationAtCurrentAnalysis.rst + .. include:: snippets/MahalanobisConsistency.rst .. include:: snippets/OMA.rst diff --git a/doc/en/ref_algorithm_LinearLeastSquares.rst b/doc/en/ref_algorithm_LinearLeastSquares.rst index 667eaae..68fe08b 100644 --- a/doc/en/ref_algorithm_LinearLeastSquares.rst +++ b/doc/en/ref_algorithm_LinearLeastSquares.rst @@ -57,6 +57,8 @@ In all cases, it is recommanded to prefer at least the .. ------------------------------------ .. .. include:: snippets/Header2Algo03AdOp.rst +.. include:: snippets/EstimationOf_Parameters.rst + StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations @@ -79,6 +81,8 @@ StoreSupplementaryCalculations "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", + "ForecastState", + "InnovationAtCurrentAnalysis", "OMA", "SimulatedObservationAtCurrentOptimum", "SimulatedObservationAtCurrentState", @@ -127,6 +131,10 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + +.. include:: snippets/InnovationAtCurrentAnalysis.rst + .. include:: snippets/OMA.rst .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst diff --git a/doc/en/ref_algorithm_NonLinearLeastSquares.rst b/doc/en/ref_algorithm_NonLinearLeastSquares.rst index c8b0bcf..2c7b9b4 100644 --- a/doc/en/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/en/ref_algorithm_NonLinearLeastSquares.rst @@ -60,6 +60,8 @@ for its stability as for its behavior during optimization. .. include:: snippets/CostDecrementTolerance.rst +.. include:: snippets/EstimationOf_Parameters.rst + .. include:: snippets/GradientNormTolerance.rst .. include:: snippets/InitializationPoint.rst @@ -95,8 +97,10 @@ StoreSupplementaryCalculations "CurrentIterationNumber", "CurrentOptimum", "CurrentState", + "ForecastState", "IndexOfOptimum", "Innovation", + "InnovationAtCurrentAnalysis", "InnovationAtCurrentState", "OMA", "OMB", @@ -152,10 +156,14 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + .. include:: snippets/IndexOfOptimum.rst .. include:: snippets/Innovation.rst +.. include:: snippets/InnovationAtCurrentAnalysis.rst + .. include:: snippets/InnovationAtCurrentState.rst .. include:: snippets/OMA.rst diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst index c82bf76..a1f3a85 100644 --- a/doc/fr/ref_algorithm_Blue.rst +++ b/doc/fr/ref_algorithm_Blue.rst @@ -72,6 +72,8 @@ pas proposée. .. ------------------------------------ .. .. include:: snippets/Header2Algo03AdOp.rst +.. include:: snippets/EstimationOf_Parameters.rst + .. include:: snippets/NumberOfSamplesForQuantiles.rst .. include:: snippets/Quantiles.rst @@ -109,7 +111,9 @@ StoreSupplementaryCalculations "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", + "ForecastState", "Innovation", + "InnovationAtCurrentAnalysis", "MahalanobisConsistency", "OMA", "OMB", @@ -162,8 +166,12 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + .. include:: snippets/Innovation.rst +.. include:: snippets/InnovationAtCurrentAnalysis.rst + .. include:: snippets/MahalanobisConsistency.rst .. include:: snippets/OMA.rst diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst index a39b198..fae75cd 100644 --- a/doc/fr/ref_algorithm_ExtendedBlue.rst +++ b/doc/fr/ref_algorithm_ExtendedBlue.rst @@ -57,6 +57,8 @@ lui être entièrement équivalent. .. ------------------------------------ .. .. include:: snippets/Header2Algo03AdOp.rst +.. include:: snippets/EstimationOf_Parameters.rst + .. include:: snippets/NumberOfSamplesForQuantiles.rst .. include:: snippets/Quantiles.rst @@ -94,7 +96,9 @@ StoreSupplementaryCalculations "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", + "ForecastState", "Innovation", + "InnovationAtCurrentAnalysis", "MahalanobisConsistency", "OMA", "OMB", @@ -147,8 +151,12 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + .. include:: snippets/Innovation.rst +.. include:: snippets/InnovationAtCurrentAnalysis.rst + .. include:: snippets/MahalanobisConsistency.rst .. include:: snippets/OMA.rst diff --git a/doc/fr/ref_algorithm_LinearLeastSquares.rst b/doc/fr/ref_algorithm_LinearLeastSquares.rst index 7229c49..d4c4acb 100644 --- a/doc/fr/ref_algorithm_LinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_LinearLeastSquares.rst @@ -57,6 +57,8 @@ l':ref:`section_ref_algorithm_3DVAR`. .. ------------------------------------ .. .. include:: snippets/Header2Algo03AdOp.rst +.. include:: snippets/EstimationOf_Parameters.rst + StoreSupplementaryCalculations .. index:: single: StoreSupplementaryCalculations @@ -79,6 +81,8 @@ StoreSupplementaryCalculations "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState", + "ForecastState", + "InnovationAtCurrentAnalysis", "OMA", "SimulatedObservationAtCurrentOptimum", "SimulatedObservationAtCurrentState", @@ -128,6 +132,10 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + +.. include:: snippets/InnovationAtCurrentAnalysis.rst + .. include:: snippets/OMA.rst .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst index 3de2855..aed53dc 100644 --- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst @@ -61,6 +61,8 @@ comportement lors de l'optimisation. .. include:: snippets/CostDecrementTolerance.rst +.. include:: snippets/EstimationOf_Parameters.rst + .. include:: snippets/GradientNormTolerance.rst .. include:: snippets/InitializationPoint.rst @@ -96,8 +98,10 @@ StoreSupplementaryCalculations "CurrentIterationNumber", "CurrentOptimum", "CurrentState", + "ForecastState", "IndexOfOptimum", "Innovation", + "InnovationAtCurrentAnalysis", "InnovationAtCurrentState", "OMA", "OMB", @@ -154,10 +158,14 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + .. include:: snippets/IndexOfOptimum.rst .. include:: snippets/Innovation.rst +.. include:: snippets/InnovationAtCurrentAnalysis.rst + .. include:: snippets/InnovationAtCurrentState.rst .. include:: snippets/OMA.rst -- 2.39.2