From 11cbdca9c0689e96409009e5db5a2956e304e233 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Fri, 27 Jan 2023 21:11:45 +0100 Subject: [PATCH] Minor documentation and code review corrections (39) --- doc/en/ref_algorithm_3DVAR.rst | 1 + doc/en/ref_algorithm_4DVAR.rst | 1 + doc/en/ref_algorithm_AdjointTest.rst | 1 + doc/en/ref_algorithm_Blue.rst | 1 + doc/en/ref_algorithm_DerivativeFreeOptimization.rst | 1 + doc/en/ref_algorithm_DifferentialEvolution.rst | 1 + doc/en/ref_algorithm_EnsembleBlue.rst | 1 + doc/en/ref_algorithm_EnsembleKalmanFilter.rst | 1 + doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst | 1 + doc/en/ref_algorithm_ExtendedBlue.rst | 1 + doc/en/ref_algorithm_ExtendedKalmanFilter.rst | 1 + doc/en/ref_algorithm_FunctionTest.rst | 1 + doc/en/ref_algorithm_GradientTest.rst | 1 + doc/en/ref_algorithm_InputValuesTest.rst | 2 ++ doc/en/ref_algorithm_KalmanFilter.rst | 1 + doc/en/ref_algorithm_LinearLeastSquares.rst | 1 + doc/en/ref_algorithm_LinearityTest.rst | 1 + doc/en/ref_algorithm_LocalSensitivityTest.rst | 1 + doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst | 1 + doc/en/ref_algorithm_NonLinearLeastSquares.rst | 1 + doc/en/ref_algorithm_ParallelFunctionTest.rst | 1 + doc/en/ref_algorithm_ParticleSwarmOptimization.rst | 1 + doc/en/ref_algorithm_QuantileRegression.rst | 1 + doc/en/ref_algorithm_SamplingTest.rst | 1 + doc/en/ref_algorithm_TabuSearch.rst | 1 + doc/en/ref_algorithm_TangentTest.rst | 1 + doc/en/ref_algorithm_UnscentedKalmanFilter.rst | 1 + doc/fr/ref_algorithm_3DVAR.rst | 1 + doc/fr/ref_algorithm_4DVAR.rst | 1 + doc/fr/ref_algorithm_AdjointTest.rst | 3 ++- doc/fr/ref_algorithm_Blue.rst | 1 + doc/fr/ref_algorithm_DerivativeFreeOptimization.rst | 1 + doc/fr/ref_algorithm_DifferentialEvolution.rst | 1 + doc/fr/ref_algorithm_EnsembleBlue.rst | 1 + doc/fr/ref_algorithm_EnsembleKalmanFilter.rst | 1 + doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst | 1 + doc/fr/ref_algorithm_ExtendedBlue.rst | 1 + doc/fr/ref_algorithm_ExtendedKalmanFilter.rst | 1 + doc/fr/ref_algorithm_FunctionTest.rst | 1 + doc/fr/ref_algorithm_GradientTest.rst | 1 + doc/fr/ref_algorithm_InputValuesTest.rst | 3 +++ doc/fr/ref_algorithm_KalmanFilter.rst | 1 + doc/fr/ref_algorithm_LinearLeastSquares.rst | 1 + doc/fr/ref_algorithm_LinearityTest.rst | 1 + doc/fr/ref_algorithm_LocalSensitivityTest.rst | 1 + doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst | 1 + doc/fr/ref_algorithm_NonLinearLeastSquares.rst | 1 + doc/fr/ref_algorithm_ParallelFunctionTest.rst | 1 + doc/fr/ref_algorithm_ParticleSwarmOptimization.rst | 1 + doc/fr/ref_algorithm_QuantileRegression.rst | 1 + doc/fr/ref_algorithm_SamplingTest.rst | 1 + doc/fr/ref_algorithm_TabuSearch.rst | 1 + doc/fr/ref_algorithm_TangentTest.rst | 5 ++++- doc/fr/ref_algorithm_UnscentedKalmanFilter.rst | 1 + test/test1001/Versions.py | 2 -- test/test1002/Performances.py | 1 - test/test6702/Doc_TUI_Exemple_02.py | 2 -- test/test6703/Doc_TUI_Exemple_03.py | 2 -- test/test6704/Doc_TUI_Exemple_03_en_multifonction.py | 2 -- test/test6711/Doc_TUI_Exemple_01_Savings.py | 2 -- test/test6901/Verification_des_Assimilation_Algorithms.py | 4 ---- test/test6903/Verification_des_mono_et_multi_fonctions_A.py | 2 -- test/test6903/Verification_des_mono_et_multi_fonctions_B.py | 2 -- test/test6903/Verification_des_mono_et_multi_fonctions_C.py | 2 -- test/test6903/Verification_des_mono_et_multi_fonctions_D.py | 2 -- test/test6903/Verification_des_mono_et_multi_fonctions_E.py | 2 -- test/test6903/Verification_des_mono_et_multi_fonctions_F.py | 2 -- test/test6904/Definition_complete_de_cas_3DVAR.py | 2 +- test/test6904/Definition_complete_de_cas_Blue.py | 2 +- test/test6904/Definition_complete_de_cas_NLLS.py | 2 +- 70 files changed, 64 insertions(+), 32 deletions(-) diff --git a/doc/en/ref_algorithm_3DVAR.rst b/doc/en/ref_algorithm_3DVAR.rst index 6eadd01..08c4b77 100644 --- a/doc/en/ref_algorithm_3DVAR.rst +++ b/doc/en/ref_algorithm_3DVAR.rst @@ -252,6 +252,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_3DVAR_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_3DVAR.rst diff --git a/doc/en/ref_algorithm_4DVAR.rst b/doc/en/ref_algorithm_4DVAR.rst index d130fb8..39a2016 100644 --- a/doc/en/ref_algorithm_4DVAR.rst +++ b/doc/en/ref_algorithm_4DVAR.rst @@ -152,6 +152,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_4DVAR_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_3DVAR` diff --git a/doc/en/ref_algorithm_AdjointTest.rst b/doc/en/ref_algorithm_AdjointTest.rst index bc0def9..d18f962 100644 --- a/doc/en/ref_algorithm_AdjointTest.rst +++ b/doc/en/ref_algorithm_AdjointTest.rst @@ -112,6 +112,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_AdjointTest_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_AdjointTest.rst diff --git a/doc/en/ref_algorithm_Blue.rst b/doc/en/ref_algorithm_Blue.rst index 4e7bbda..b47ce59 100644 --- a/doc/en/ref_algorithm_Blue.rst +++ b/doc/en/ref_algorithm_Blue.rst @@ -209,6 +209,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_Blue_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_Blue.rst diff --git a/doc/en/ref_algorithm_DerivativeFreeOptimization.rst b/doc/en/ref_algorithm_DerivativeFreeOptimization.rst index cfb6f94..192f3c4 100644 --- a/doc/en/ref_algorithm_DerivativeFreeOptimization.rst +++ b/doc/en/ref_algorithm_DerivativeFreeOptimization.rst @@ -168,6 +168,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_DerivativeFreeOptimization_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_DerivativeFreeOptimization.rst diff --git a/doc/en/ref_algorithm_DifferentialEvolution.rst b/doc/en/ref_algorithm_DifferentialEvolution.rst index e0f1d81..4ada6fb 100644 --- a/doc/en/ref_algorithm_DifferentialEvolution.rst +++ b/doc/en/ref_algorithm_DifferentialEvolution.rst @@ -173,6 +173,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_DifferentialEvolution_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_DerivativeFreeOptimization` diff --git a/doc/en/ref_algorithm_EnsembleBlue.rst b/doc/en/ref_algorithm_EnsembleBlue.rst index fc4227b..a107feb 100644 --- a/doc/en/ref_algorithm_EnsembleBlue.rst +++ b/doc/en/ref_algorithm_EnsembleBlue.rst @@ -111,6 +111,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_EnsembleBlue_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_Blue` diff --git a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst index 2756ca7..0c9ce50 100644 --- a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst @@ -214,6 +214,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_EnsembleKalmanFilter_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_KalmanFilter` diff --git a/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst b/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst index 1624c1f..d45d313 100644 --- a/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst +++ b/doc/en/ref_algorithm_EnsembleOfSimulationGenerationTask.rst @@ -124,6 +124,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_EnsembleOfSimulationGenerationTask_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/en/ref_algorithm_ExtendedBlue.rst b/doc/en/ref_algorithm_ExtendedBlue.rst index 34f4c81..5e83c61 100644 --- a/doc/en/ref_algorithm_ExtendedBlue.rst +++ b/doc/en/ref_algorithm_ExtendedBlue.rst @@ -194,6 +194,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_ExtendedBlue_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_ExtendedBlue.rst diff --git a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst index f63e526..f643acc 100644 --- a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst @@ -205,6 +205,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_ExtendedKalmanFilter_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_KalmanFilter` diff --git a/doc/en/ref_algorithm_FunctionTest.rst b/doc/en/ref_algorithm_FunctionTest.rst index dee2969..3b57c3e 100644 --- a/doc/en/ref_algorithm_FunctionTest.rst +++ b/doc/en/ref_algorithm_FunctionTest.rst @@ -94,6 +94,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_FunctionTest_examples: + .. include:: snippets/Header2Algo09.rst .. --------- .. diff --git a/doc/en/ref_algorithm_GradientTest.rst b/doc/en/ref_algorithm_GradientTest.rst index 0744063..ad705d9 100644 --- a/doc/en/ref_algorithm_GradientTest.rst +++ b/doc/en/ref_algorithm_GradientTest.rst @@ -147,6 +147,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_GradientTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/en/ref_algorithm_InputValuesTest.rst b/doc/en/ref_algorithm_InputValuesTest.rst index 43eec07..32ff3da 100644 --- a/doc/en/ref_algorithm_InputValuesTest.rst +++ b/doc/en/ref_algorithm_InputValuesTest.rst @@ -68,6 +68,8 @@ if a variable is large in size, this can be difficult*). .. include:: snippets/SetDebug.rst .. ------------------------------------ .. +.. _section_ref_algorithm_InputValuesTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/en/ref_algorithm_KalmanFilter.rst b/doc/en/ref_algorithm_KalmanFilter.rst index 9ea11dc..ec4b040 100644 --- a/doc/en/ref_algorithm_KalmanFilter.rst +++ b/doc/en/ref_algorithm_KalmanFilter.rst @@ -196,6 +196,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_KalmanFilter_examples: + .. include:: snippets/Header2Algo09.rst .. --------- .. diff --git a/doc/en/ref_algorithm_LinearLeastSquares.rst b/doc/en/ref_algorithm_LinearLeastSquares.rst index 74a0ad2..a9fb5ad 100644 --- a/doc/en/ref_algorithm_LinearLeastSquares.rst +++ b/doc/en/ref_algorithm_LinearLeastSquares.rst @@ -155,6 +155,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_LinearLeastSquares_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_Blue` diff --git a/doc/en/ref_algorithm_LinearityTest.rst b/doc/en/ref_algorithm_LinearityTest.rst index 2976e87..ffca299 100644 --- a/doc/en/ref_algorithm_LinearityTest.rst +++ b/doc/en/ref_algorithm_LinearityTest.rst @@ -168,6 +168,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_LinearityTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/en/ref_algorithm_LocalSensitivityTest.rst b/doc/en/ref_algorithm_LocalSensitivityTest.rst index 6327f71..4a22bf7 100644 --- a/doc/en/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/en/ref_algorithm_LocalSensitivityTest.rst @@ -95,6 +95,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_LocalSensitivityTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst index a944d83..0d305c9 100644 --- a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -148,6 +148,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_MeasurementsOptimalPositioningTask_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/en/ref_algorithm_NonLinearLeastSquares.rst b/doc/en/ref_algorithm_NonLinearLeastSquares.rst index 2ce1d6c..4bd2150 100644 --- a/doc/en/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/en/ref_algorithm_NonLinearLeastSquares.rst @@ -190,6 +190,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_NonLinearLeastSquares_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_NonLinearLeastSquares.rst diff --git a/doc/en/ref_algorithm_ParallelFunctionTest.rst b/doc/en/ref_algorithm_ParallelFunctionTest.rst index d14f81f..3f4ace7 100644 --- a/doc/en/ref_algorithm_ParallelFunctionTest.rst +++ b/doc/en/ref_algorithm_ParallelFunctionTest.rst @@ -95,6 +95,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_ParallelFunctionTest_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_ParallelFunctionTest.rst diff --git a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst index b9596bc..04e12a5 100644 --- a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst @@ -148,6 +148,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_ParticleSwarmOptimization_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_DerivativeFreeOptimization` diff --git a/doc/en/ref_algorithm_QuantileRegression.rst b/doc/en/ref_algorithm_QuantileRegression.rst index 87c62ae..a366fb5 100644 --- a/doc/en/ref_algorithm_QuantileRegression.rst +++ b/doc/en/ref_algorithm_QuantileRegression.rst @@ -137,6 +137,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_QuantileRegression_examples: + .. include:: snippets/Header2Algo06.rst .. ------------------------------------ .. diff --git a/doc/en/ref_algorithm_SamplingTest.rst b/doc/en/ref_algorithm_SamplingTest.rst index f924c87..63fbcee 100644 --- a/doc/en/ref_algorithm_SamplingTest.rst +++ b/doc/en/ref_algorithm_SamplingTest.rst @@ -140,6 +140,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_SamplingTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/en/ref_algorithm_TabuSearch.rst b/doc/en/ref_algorithm_TabuSearch.rst index e19e802..183ab09 100644 --- a/doc/en/ref_algorithm_TabuSearch.rst +++ b/doc/en/ref_algorithm_TabuSearch.rst @@ -157,6 +157,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_TabuSearch_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_DerivativeFreeOptimization` diff --git a/doc/en/ref_algorithm_TangentTest.rst b/doc/en/ref_algorithm_TangentTest.rst index e7c0ec1..ee55ede 100644 --- a/doc/en/ref_algorithm_TangentTest.rst +++ b/doc/en/ref_algorithm_TangentTest.rst @@ -109,6 +109,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_TangentTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst index 508c963..f4e6006 100644 --- a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst @@ -185,6 +185,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_UnscentedKalmanFilter_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_KalmanFilter` diff --git a/doc/fr/ref_algorithm_3DVAR.rst b/doc/fr/ref_algorithm_3DVAR.rst index 700527b..d3c10b4 100644 --- a/doc/fr/ref_algorithm_3DVAR.rst +++ b/doc/fr/ref_algorithm_3DVAR.rst @@ -257,6 +257,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_3DVAR_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_3DVAR.rst diff --git a/doc/fr/ref_algorithm_4DVAR.rst b/doc/fr/ref_algorithm_4DVAR.rst index 818e9ae..4f34dbb 100644 --- a/doc/fr/ref_algorithm_4DVAR.rst +++ b/doc/fr/ref_algorithm_4DVAR.rst @@ -153,6 +153,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_4DVAR_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_3DVAR` diff --git a/doc/fr/ref_algorithm_AdjointTest.rst b/doc/fr/ref_algorithm_AdjointTest.rst index c140bea..58cf3af 100644 --- a/doc/fr/ref_algorithm_AdjointTest.rst +++ b/doc/fr/ref_algorithm_AdjointTest.rst @@ -39,7 +39,7 @@ Pour toutes les formules, avec :math:`\mathbf{x}` le point courant de vérification, on prend :math:`\mathbf{dx}_0=Normal(0,\mathbf{x})` et :math:`\mathbf{dx}=\alpha_0*\mathbf{dx}_0` avec :math:`\alpha_0` un paramètre utilisateur de mise à l'échelle, par défaut à 1. :math:`F` est l'opérateur ou -le code de calcul (qui est ici acquis par la commande d'opérateur d'observation +le code de calcul (qui est ici défini par la commande d'opérateur d'observation "*ObservationOperator*"). On observe le résidu suivant, qui est la différence de deux produits scalaires : @@ -111,6 +111,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_AdjointTest_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_AdjointTest.rst diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst index a3362a3..8867e97 100644 --- a/doc/fr/ref_algorithm_Blue.rst +++ b/doc/fr/ref_algorithm_Blue.rst @@ -211,6 +211,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_Blue_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_Blue.rst diff --git a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst index ea75f1d..c0a9ab5 100644 --- a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst +++ b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst @@ -170,6 +170,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_DerivativeFreeOptimization_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_DerivativeFreeOptimization.rst diff --git a/doc/fr/ref_algorithm_DifferentialEvolution.rst b/doc/fr/ref_algorithm_DifferentialEvolution.rst index e8c4fcc..a542bbc 100644 --- a/doc/fr/ref_algorithm_DifferentialEvolution.rst +++ b/doc/fr/ref_algorithm_DifferentialEvolution.rst @@ -174,6 +174,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_DifferentialEvolution_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_DerivativeFreeOptimization` diff --git a/doc/fr/ref_algorithm_EnsembleBlue.rst b/doc/fr/ref_algorithm_EnsembleBlue.rst index 4b547c9..4c0be5d 100644 --- a/doc/fr/ref_algorithm_EnsembleBlue.rst +++ b/doc/fr/ref_algorithm_EnsembleBlue.rst @@ -111,6 +111,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_EnsembleBlue_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_Blue` diff --git a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst index 9c78cba..d219ea1 100644 --- a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst @@ -216,6 +216,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_EnsembleKalmanFilter_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_KalmanFilter` diff --git a/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst b/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst index 5dc663d..902a88d 100644 --- a/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst +++ b/doc/fr/ref_algorithm_EnsembleOfSimulationGenerationTask.rst @@ -126,6 +126,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_EnsembleOfSimulationGenerationTask_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst index b556d78..0e47e61 100644 --- a/doc/fr/ref_algorithm_ExtendedBlue.rst +++ b/doc/fr/ref_algorithm_ExtendedBlue.rst @@ -197,6 +197,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_ExtendedBlue_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_ExtendedBlue.rst diff --git a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst index 44ca126..971c2c1 100644 --- a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst @@ -206,6 +206,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_ExtendedKalmanFilter_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_KalmanFilter` diff --git a/doc/fr/ref_algorithm_FunctionTest.rst b/doc/fr/ref_algorithm_FunctionTest.rst index 24ed26d..34599b5 100644 --- a/doc/fr/ref_algorithm_FunctionTest.rst +++ b/doc/fr/ref_algorithm_FunctionTest.rst @@ -95,6 +95,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_FunctionTest_examples: + .. include:: snippets/Header2Algo09.rst .. --------- .. diff --git a/doc/fr/ref_algorithm_GradientTest.rst b/doc/fr/ref_algorithm_GradientTest.rst index e05e328..2c904d4 100644 --- a/doc/fr/ref_algorithm_GradientTest.rst +++ b/doc/fr/ref_algorithm_GradientTest.rst @@ -149,6 +149,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_GradientTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/fr/ref_algorithm_InputValuesTest.rst b/doc/fr/ref_algorithm_InputValuesTest.rst index 03dcd9f..f83c8e0 100644 --- a/doc/fr/ref_algorithm_InputValuesTest.rst +++ b/doc/fr/ref_algorithm_InputValuesTest.rst @@ -71,7 +71,10 @@ informatiquement problématique*). .. include:: snippets/SetDebug.rst .. ------------------------------------ .. +.. _section_ref_algorithm_InputValuesTest_examples: + .. include:: snippets/Header2Algo06.rst +- :ref:`section_ref_algorithm_ControledFunctionTest` - :ref:`section_ref_algorithm_FunctionTest` - :ref:`section_ref_algorithm_ParallelFunctionTest` diff --git a/doc/fr/ref_algorithm_KalmanFilter.rst b/doc/fr/ref_algorithm_KalmanFilter.rst index ec4f692..c513b4b 100644 --- a/doc/fr/ref_algorithm_KalmanFilter.rst +++ b/doc/fr/ref_algorithm_KalmanFilter.rst @@ -197,6 +197,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_KalmanFilter_examples: + .. include:: snippets/Header2Algo09.rst .. --------- .. diff --git a/doc/fr/ref_algorithm_LinearLeastSquares.rst b/doc/fr/ref_algorithm_LinearLeastSquares.rst index 1aa6706..77856fb 100644 --- a/doc/fr/ref_algorithm_LinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_LinearLeastSquares.rst @@ -157,6 +157,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_LinearLeastSquares_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_Blue` diff --git a/doc/fr/ref_algorithm_LinearityTest.rst b/doc/fr/ref_algorithm_LinearityTest.rst index c8b09a5..8d0878a 100644 --- a/doc/fr/ref_algorithm_LinearityTest.rst +++ b/doc/fr/ref_algorithm_LinearityTest.rst @@ -173,6 +173,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_LinearityTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/fr/ref_algorithm_LocalSensitivityTest.rst b/doc/fr/ref_algorithm_LocalSensitivityTest.rst index 79b14e1..9b10345 100644 --- a/doc/fr/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/fr/ref_algorithm_LocalSensitivityTest.rst @@ -96,6 +96,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_LocalSensitivityTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst index 4938329..c53d924 100644 --- a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -150,6 +150,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_MeasurementsOptimalPositioningTask_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst index 4e8ec4b..b60d063 100644 --- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst @@ -193,6 +193,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_NonLinearLeastSquares_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_NonLinearLeastSquares.rst diff --git a/doc/fr/ref_algorithm_ParallelFunctionTest.rst b/doc/fr/ref_algorithm_ParallelFunctionTest.rst index 2f75a94..c0d56a9 100644 --- a/doc/fr/ref_algorithm_ParallelFunctionTest.rst +++ b/doc/fr/ref_algorithm_ParallelFunctionTest.rst @@ -96,6 +96,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_ParallelFunctionTest_examples: + .. include:: snippets/Header2Algo09.rst .. include:: scripts/simple_ParallelFunctionTest.rst diff --git a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst index f8f6899..590ea3d 100644 --- a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst @@ -149,6 +149,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_ParticleSwarmOptimization_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_DerivativeFreeOptimization` diff --git a/doc/fr/ref_algorithm_QuantileRegression.rst b/doc/fr/ref_algorithm_QuantileRegression.rst index 2884dfd..11e1848 100644 --- a/doc/fr/ref_algorithm_QuantileRegression.rst +++ b/doc/fr/ref_algorithm_QuantileRegression.rst @@ -138,6 +138,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_QuantileRegression_examples: + .. include:: snippets/Header2Algo06.rst .. ------------------------------------ .. diff --git a/doc/fr/ref_algorithm_SamplingTest.rst b/doc/fr/ref_algorithm_SamplingTest.rst index 42a2953..f4bae25 100644 --- a/doc/fr/ref_algorithm_SamplingTest.rst +++ b/doc/fr/ref_algorithm_SamplingTest.rst @@ -143,6 +143,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_SamplingTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/fr/ref_algorithm_TabuSearch.rst b/doc/fr/ref_algorithm_TabuSearch.rst index 6957a7b..d96e825 100644 --- a/doc/fr/ref_algorithm_TabuSearch.rst +++ b/doc/fr/ref_algorithm_TabuSearch.rst @@ -159,6 +159,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_TabuSearch_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_DerivativeFreeOptimization` diff --git a/doc/fr/ref_algorithm_TangentTest.rst b/doc/fr/ref_algorithm_TangentTest.rst index 718a981..9a8472f 100644 --- a/doc/fr/ref_algorithm_TangentTest.rst +++ b/doc/fr/ref_algorithm_TangentTest.rst @@ -38,7 +38,7 @@ Pour toutes les formules, avec :math:`\mathbf{x}` le point courant de vérification, on prend :math:`\mathbf{dx}_0=Normal(0,\mathbf{x})` et :math:`\mathbf{dx}=\alpha_0*\mathbf{dx}_0` avec :math:`\alpha_0` un paramètre utilisateur de mise à l'échelle, par défaut à 1. :math:`F` est l'opérateur ou -le code de calcul (qui est ici acquis par la commande d'opérateur d'observation +le code de calcul (qui est ici défini par la commande d'opérateur d'observation "*ObservationOperator*"). On observe le résidu suivant, provenant du rapport d'incréments utilisant @@ -76,6 +76,8 @@ ce que l'on atteigne la précision du calcul. .. include:: snippets/InitialDirection.rst +.. include:: snippets/NumberOfPrintedDigits.rst + .. include:: snippets/SetSeed.rst StoreSupplementaryCalculations @@ -115,6 +117,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_TangentTest_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_FunctionTest` diff --git a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst index 2cb5f43..2689ddb 100644 --- a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst @@ -186,6 +186,7 @@ StoreSupplementaryCalculations .. ------------------------------------ .. .. _section_ref_algorithm_UnscentedKalmanFilter_examples: + .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_KalmanFilter` diff --git a/test/test1001/Versions.py b/test/test1001/Versions.py index 8ec3be3..e409b84 100644 --- a/test/test1001/Versions.py +++ b/test/test1001/Versions.py @@ -134,8 +134,6 @@ class Test_Versions(unittest.TestCase): print("") print(" Les résultats obtenus sont corrects.") print("") - # - return 0 def compare_versions(v1,v2): "Comparaison v1 >= v2" diff --git a/test/test1002/Performances.py b/test/test1002/Performances.py index c5fb564..0bd5430 100644 --- a/test/test1002/Performances.py +++ b/test/test1002/Performances.py @@ -51,7 +51,6 @@ class Test_Adao(unittest.TestCase): else: print(' - Lapack............: numpy n\'indique plus où le trouver') print("") - return True #~ @unittest.skip("Debug") def test_Numpy01(self, dimension = 10000, precision = 1.e-17, repetitions = 10): diff --git a/test/test6702/Doc_TUI_Exemple_02.py b/test/test6702/Doc_TUI_Exemple_02.py index 746bb51..f530e92 100644 --- a/test/test6702/Doc_TUI_Exemple_02.py +++ b/test/test6702/Doc_TUI_Exemple_02.py @@ -49,7 +49,6 @@ class Test_Adao(unittest.TestCase): # xa = case.get("Analysis")[-1] Test_Adao.results.append( xa ) - return xa def test2(self): """Test""" @@ -76,7 +75,6 @@ class Test_Adao(unittest.TestCase): # xa = case.get("Analysis")[-1] Test_Adao.results.append( xa ) - return xa def test3(self): """Test""" diff --git a/test/test6703/Doc_TUI_Exemple_03.py b/test/test6703/Doc_TUI_Exemple_03.py index b002410..706630b 100644 --- a/test/test6703/Doc_TUI_Exemple_03.py +++ b/test/test6703/Doc_TUI_Exemple_03.py @@ -116,8 +116,6 @@ class Test_Adao(unittest.TestCase): print(" L'écart absolu maximal obtenu lors du test est de %.2e."%ecart) print(" Les résultats obtenus sont corrects.") print("") - # - return xa # ============================================================================== def assertAlmostEqualArrays(first, second, places=7, msg=None, delta=None): diff --git a/test/test6704/Doc_TUI_Exemple_03_en_multifonction.py b/test/test6704/Doc_TUI_Exemple_03_en_multifonction.py index a45d247..c492d51 100644 --- a/test/test6704/Doc_TUI_Exemple_03_en_multifonction.py +++ b/test/test6704/Doc_TUI_Exemple_03_en_multifonction.py @@ -123,8 +123,6 @@ class Test_Adao(unittest.TestCase): print(" L'écart absolu maximal obtenu lors du test est de %.2e."%ecart) print(" Les résultats obtenus sont corrects.") print("") - # - return xa # ============================================================================== def assertAlmostEqualArrays(first, second, places=7, msg=None, delta=None): diff --git a/test/test6711/Doc_TUI_Exemple_01_Savings.py b/test/test6711/Doc_TUI_Exemple_01_Savings.py index cf2d2a3..08df46e 100644 --- a/test/test6711/Doc_TUI_Exemple_01_Savings.py +++ b/test/test6711/Doc_TUI_Exemple_01_Savings.py @@ -93,8 +93,6 @@ class Test_Adao(unittest.TestCase): print(" L'écart absolu maximal obtenu lors du test est de %.2e."%ecart) print(" Les résultats obtenus sont corrects.") print("") - # - return xa # ============================================================================== def filesize(name): diff --git a/test/test6901/Verification_des_Assimilation_Algorithms.py b/test/test6901/Verification_des_Assimilation_Algorithms.py index 2b700de..4745c0c 100644 --- a/test/test6901/Verification_des_Assimilation_Algorithms.py +++ b/test/test6901/Verification_des_Assimilation_Algorithms.py @@ -111,8 +111,6 @@ class Test_Adao(unittest.TestCase): verify_similarity_of_algo_results(("KalmanFilter", "EnsembleKalmanFilter"), Xa, 2.e-1) print(" Les resultats obtenus sont corrects.") print("") - # - return 0 def test2(self): """Verification de la disponibilite de l'ensemble des algorithmes\n(Utilisation d'un operateur fonctionnel)""" @@ -185,8 +183,6 @@ class Test_Adao(unittest.TestCase): verify_similarity_of_algo_results(("KalmanFilter", "EnsembleKalmanFilter"), Xa, 2e-1) print(" Les resultats obtenus sont corrects.") print("") - # - return 0 def almost_equal_vectors(v1, v2, precision = 1.e-15, msg = ""): """Comparaison de deux vecteurs""" diff --git a/test/test6903/Verification_des_mono_et_multi_fonctions_A.py b/test/test6903/Verification_des_mono_et_multi_fonctions_A.py index 850fcdf..97b7586 100644 --- a/test/test6903/Verification_des_mono_et_multi_fonctions_A.py +++ b/test/test6903/Verification_des_mono_et_multi_fonctions_A.py @@ -89,8 +89,6 @@ class Test_Adao(unittest.TestCase): verify_similarity_of_algo_results(("Multi/"+algo, "Mono/"+algo), Xa, 1.e-20) print(" Les resultats obtenus sont corrects.") print("") - # - return 0 # # ============================================================================== def almost_equal_vectors(v1, v2, precision = 1.e-15, msg = ""): diff --git a/test/test6903/Verification_des_mono_et_multi_fonctions_B.py b/test/test6903/Verification_des_mono_et_multi_fonctions_B.py index c655880..1be613a 100644 --- a/test/test6903/Verification_des_mono_et_multi_fonctions_B.py +++ b/test/test6903/Verification_des_mono_et_multi_fonctions_B.py @@ -93,8 +93,6 @@ class Test_Adao(unittest.TestCase): verify_similarity_of_algo_results(("Multi/"+algo, "Mono/"+algo), Xa, 1.e-20) print(" Les resultats obtenus sont corrects.") print("") - # - return 0 # ============================================================================== def almost_equal_vectors(v1, v2, precision = 1.e-15, msg = ""): diff --git a/test/test6903/Verification_des_mono_et_multi_fonctions_C.py b/test/test6903/Verification_des_mono_et_multi_fonctions_C.py index 4bac258..4895459 100644 --- a/test/test6903/Verification_des_mono_et_multi_fonctions_C.py +++ b/test/test6903/Verification_des_mono_et_multi_fonctions_C.py @@ -89,8 +89,6 @@ class Test_Adao(unittest.TestCase): verify_similarity_of_algo_results(("Multi/"+algo, "Mono/"+algo), Xa, 1.e-20) print(" Les resultats obtenus sont corrects.") print("") - # - return 0 # ============================================================================== def almost_equal_vectors(v1, v2, precision = 1.e-15, msg = ""): diff --git a/test/test6903/Verification_des_mono_et_multi_fonctions_D.py b/test/test6903/Verification_des_mono_et_multi_fonctions_D.py index fe8ef46..5b3e6be 100644 --- a/test/test6903/Verification_des_mono_et_multi_fonctions_D.py +++ b/test/test6903/Verification_des_mono_et_multi_fonctions_D.py @@ -117,8 +117,6 @@ class Test_Adao(unittest.TestCase): verify_similarity_of_algo_results(("Multi/"+algo, "Mono/"+algo), Xa, 1.e-20) print(" Les resultats obtenus sont corrects.") print("") - # - return 0 # ============================================================================== def almost_equal_vectors(v1, v2, precision = 1.e-15, msg = ""): diff --git a/test/test6903/Verification_des_mono_et_multi_fonctions_E.py b/test/test6903/Verification_des_mono_et_multi_fonctions_E.py index 9d52c88..20a27b8 100644 --- a/test/test6903/Verification_des_mono_et_multi_fonctions_E.py +++ b/test/test6903/Verification_des_mono_et_multi_fonctions_E.py @@ -121,8 +121,6 @@ class Test_Adao(unittest.TestCase): verify_similarity_of_algo_results(("Multi/"+algo, "Mono/"+algo), Xa, 1.e-20) print(" Les resultats obtenus sont corrects.") print("") - # - return 0 # ============================================================================== def almost_equal_vectors(v1, v2, precision = 1.e-15, msg = ""): diff --git a/test/test6903/Verification_des_mono_et_multi_fonctions_F.py b/test/test6903/Verification_des_mono_et_multi_fonctions_F.py index 6e356cb..99f0d84 100644 --- a/test/test6903/Verification_des_mono_et_multi_fonctions_F.py +++ b/test/test6903/Verification_des_mono_et_multi_fonctions_F.py @@ -117,8 +117,6 @@ class Test_Adao(unittest.TestCase): verify_similarity_of_algo_results(("Multi/"+algo, "Mono/"+algo), Xa, 1.e-20) print(" Les resultats obtenus sont corrects.") print("") - # - return 0 # ============================================================================== def almost_equal_vectors(v1, v2, precision = 1.e-15, msg = ""): diff --git a/test/test6904/Definition_complete_de_cas_3DVAR.py b/test/test6904/Definition_complete_de_cas_3DVAR.py index ceffdad..250e113 100644 --- a/test/test6904/Definition_complete_de_cas_3DVAR.py +++ b/test/test6904/Definition_complete_de_cas_3DVAR.py @@ -147,7 +147,7 @@ class Test_Adao(unittest.TestCase): print("The results are correct.") print("") # - return Xoptimum + # return Xoptimum # ============================================================================== def assertAlmostEqualArrays(first, second, places=7, msg=None, delta=None): diff --git a/test/test6904/Definition_complete_de_cas_Blue.py b/test/test6904/Definition_complete_de_cas_Blue.py index b4be8d6..427b50a 100644 --- a/test/test6904/Definition_complete_de_cas_Blue.py +++ b/test/test6904/Definition_complete_de_cas_Blue.py @@ -144,7 +144,7 @@ class Test_Adao(unittest.TestCase): print("The results are correct.") print("") # - return Xoptimum + # return Xoptimum # ============================================================================== def assertAlmostEqualArrays(first, second, places=7, msg=None, delta=None): diff --git a/test/test6904/Definition_complete_de_cas_NLLS.py b/test/test6904/Definition_complete_de_cas_NLLS.py index d8b5569..99a4cbf 100644 --- a/test/test6904/Definition_complete_de_cas_NLLS.py +++ b/test/test6904/Definition_complete_de_cas_NLLS.py @@ -142,7 +142,7 @@ class Test_Adao(unittest.TestCase): print("The results are correct.") print("") # - return Xoptimum + # return Xoptimum # ============================================================================== def assertAlmostEqualArrays(first, second, places=7, msg=None, delta=None): -- 2.39.2