From 82e2f02cd3b3506fa14bcb7cb23c096f7627f1c3 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Fri, 5 Mar 2021 23:02:53 +0100 Subject: [PATCH] Minor documentation improvements --- doc/en/ref_algorithm_3DVAR.rst | 3 +++ doc/en/ref_algorithm_NonLinearLeastSquares.rst | 2 ++ doc/en/scripts/simple_3DVAR.py | 1 + doc/en/scripts/simple_NonLinearLeastSquares.py | 1 + doc/fr/ref_algorithm_3DVAR.rst | 3 +++ doc/fr/ref_algorithm_NonLinearLeastSquares.rst | 2 ++ doc/fr/scripts/simple_3DVAR.py | 1 + doc/fr/scripts/simple_NonLinearLeastSquares.py | 1 + 8 files changed, 14 insertions(+) diff --git a/doc/en/ref_algorithm_3DVAR.rst b/doc/en/ref_algorithm_3DVAR.rst index ff875c2..579832a 100644 --- a/doc/en/ref_algorithm_3DVAR.rst +++ b/doc/en/ref_algorithm_3DVAR.rst @@ -116,6 +116,7 @@ StoreSupplementaryCalculations "CurrentIterationNumber", "CurrentOptimum", "CurrentState", + "ForecastState", "IndexOfOptimum", "Innovation", "InnovationAtCurrentState", @@ -182,6 +183,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + .. include:: snippets/IndexOfOptimum.rst .. include:: snippets/Innovation.rst diff --git a/doc/en/ref_algorithm_NonLinearLeastSquares.rst b/doc/en/ref_algorithm_NonLinearLeastSquares.rst index 263ce44..fa71f4d 100644 --- a/doc/en/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/en/ref_algorithm_NonLinearLeastSquares.rst @@ -62,6 +62,8 @@ for its stability as for its behavior during optimization. .. include:: snippets/GradientNormTolerance.rst +.. include:: snippets/InitializationPoint.rst + .. include:: snippets/MaximumNumberOfSteps.rst .. include:: snippets/Minimizer_xDVAR.rst diff --git a/doc/en/scripts/simple_3DVAR.py b/doc/en/scripts/simple_3DVAR.py index 4ab355f..f13bb73 100644 --- a/doc/en/scripts/simple_3DVAR.py +++ b/doc/en/scripts/simple_3DVAR.py @@ -28,6 +28,7 @@ case.setObservationOperator( OneFunction = QuadFunction ) case.setAlgorithmParameters( Algorithm='3DVAR', Parameters={ + 'MaximumNumberOfSteps': 100, 'StoreSupplementaryCalculations': [ 'CurrentState', ], diff --git a/doc/en/scripts/simple_NonLinearLeastSquares.py b/doc/en/scripts/simple_NonLinearLeastSquares.py index 564bf34..601bd6a 100644 --- a/doc/en/scripts/simple_NonLinearLeastSquares.py +++ b/doc/en/scripts/simple_NonLinearLeastSquares.py @@ -27,6 +27,7 @@ case.setObservationOperator( OneFunction = QuadFunction ) case.setAlgorithmParameters( Algorithm='NonLinearLeastSquares', Parameters={ + 'MaximumNumberOfSteps': 100, 'StoreSupplementaryCalculations': [ 'CurrentState', ], diff --git a/doc/fr/ref_algorithm_3DVAR.rst b/doc/fr/ref_algorithm_3DVAR.rst index 6fadb6f..0076212 100644 --- a/doc/fr/ref_algorithm_3DVAR.rst +++ b/doc/fr/ref_algorithm_3DVAR.rst @@ -119,6 +119,7 @@ StoreSupplementaryCalculations "CurrentIterationNumber", "CurrentOptimum", "CurrentState", + "ForecastState", "IndexOfOptimum", "Innovation", "InnovationAtCurrentState", @@ -185,6 +186,8 @@ StoreSupplementaryCalculations .. include:: snippets/CurrentState.rst +.. include:: snippets/ForecastState.rst + .. include:: snippets/IndexOfOptimum.rst .. include:: snippets/Innovation.rst diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst index 3a4cdc3..4bc6c60 100644 --- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst @@ -63,6 +63,8 @@ comportement lors de l'optimisation. .. include:: snippets/GradientNormTolerance.rst +.. include:: snippets/InitializationPoint.rst + .. include:: snippets/MaximumNumberOfSteps.rst .. include:: snippets/Minimizer_xDVAR.rst diff --git a/doc/fr/scripts/simple_3DVAR.py b/doc/fr/scripts/simple_3DVAR.py index 82a332a..04dcf56 100644 --- a/doc/fr/scripts/simple_3DVAR.py +++ b/doc/fr/scripts/simple_3DVAR.py @@ -28,6 +28,7 @@ case.setObservationOperator( OneFunction = QuadFunction ) case.setAlgorithmParameters( Algorithm='3DVAR', Parameters={ + 'MaximumNumberOfSteps': 100, 'StoreSupplementaryCalculations': [ 'CurrentState', ], diff --git a/doc/fr/scripts/simple_NonLinearLeastSquares.py b/doc/fr/scripts/simple_NonLinearLeastSquares.py index e063d09..72d8f3b 100644 --- a/doc/fr/scripts/simple_NonLinearLeastSquares.py +++ b/doc/fr/scripts/simple_NonLinearLeastSquares.py @@ -27,6 +27,7 @@ case.setObservationOperator( OneFunction = QuadFunction ) case.setAlgorithmParameters( Algorithm='NonLinearLeastSquares', Parameters={ + 'MaximumNumberOfSteps': 100, 'StoreSupplementaryCalculations': [ 'CurrentState', ], -- 2.39.2