From 67b6b343d7723960cf35e3a76a4b0fb8f6e161de Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Thu, 19 Jan 2023 18:07:04 +0100 Subject: [PATCH] Documentation update --- doc/en/ref_algorithm_3DVAR.rst | 2 +- doc/en/ref_algorithm_4DVAR.rst | 2 +- doc/en/ref_algorithm_AdjointTest.rst | 2 +- doc/en/ref_algorithm_Blue.rst | 2 +- ...f_algorithm_DerivativeFreeOptimization.rst | 2 +- .../ref_algorithm_DifferentialEvolution.rst | 2 +- doc/en/ref_algorithm_EnsembleBlue.rst | 2 +- doc/en/ref_algorithm_EnsembleKalmanFilter.rst | 2 +- doc/en/ref_algorithm_ExtendedBlue.rst | 2 +- doc/en/ref_algorithm_ExtendedKalmanFilter.rst | 2 +- doc/en/ref_algorithm_FunctionTest.rst | 2 +- doc/en/ref_algorithm_GradientTest.rst | 2 +- doc/en/ref_algorithm_KalmanFilter.rst | 2 +- doc/en/ref_algorithm_LinearLeastSquares.rst | 2 +- doc/en/ref_algorithm_LinearityTest.rst | 2 +- doc/en/ref_algorithm_LocalSensitivityTest.rst | 2 +- ...thm_MeasurementsOptimalPositioningTask.rst | 16 ++++++++-------- .../ref_algorithm_NonLinearLeastSquares.rst | 2 +- doc/en/ref_algorithm_ParallelFunctionTest.rst | 2 +- ...ef_algorithm_ParticleSwarmOptimization.rst | 2 +- doc/en/ref_algorithm_QuantileRegression.rst | 2 +- doc/en/ref_algorithm_SamplingTest.rst | 2 +- doc/en/ref_algorithm_TabuSearch.rst | 2 +- doc/en/ref_algorithm_TangentTest.rst | 2 +- .../ref_algorithm_UnscentedKalmanFilter.rst | 2 +- doc/en/snippets/ModuleCompatibility.rst | 2 +- doc/fr/ref_algorithm_3DVAR.rst | 2 +- doc/fr/ref_algorithm_4DVAR.rst | 2 +- doc/fr/ref_algorithm_AdjointTest.rst | 2 +- doc/fr/ref_algorithm_Blue.rst | 2 +- ...f_algorithm_DerivativeFreeOptimization.rst | 2 +- .../ref_algorithm_DifferentialEvolution.rst | 2 +- doc/fr/ref_algorithm_EnsembleBlue.rst | 2 +- doc/fr/ref_algorithm_EnsembleKalmanFilter.rst | 2 +- doc/fr/ref_algorithm_ExtendedBlue.rst | 2 +- doc/fr/ref_algorithm_ExtendedKalmanFilter.rst | 2 +- doc/fr/ref_algorithm_FunctionTest.rst | 2 +- doc/fr/ref_algorithm_GradientTest.rst | 2 +- doc/fr/ref_algorithm_KalmanFilter.rst | 2 +- doc/fr/ref_algorithm_LinearLeastSquares.rst | 2 +- doc/fr/ref_algorithm_LinearityTest.rst | 2 +- doc/fr/ref_algorithm_LocalSensitivityTest.rst | 2 +- ...thm_MeasurementsOptimalPositioningTask.rst | 19 ++++++++++++------- .../ref_algorithm_NonLinearLeastSquares.rst | 2 +- doc/fr/ref_algorithm_ParallelFunctionTest.rst | 2 +- ...ef_algorithm_ParticleSwarmOptimization.rst | 2 +- doc/fr/ref_algorithm_QuantileRegression.rst | 2 +- doc/fr/ref_algorithm_SamplingTest.rst | 2 +- doc/fr/ref_algorithm_TabuSearch.rst | 2 +- doc/fr/ref_algorithm_TangentTest.rst | 2 +- .../ref_algorithm_UnscentedKalmanFilter.rst | 2 +- doc/fr/snippets/ModuleCompatibility.rst | 2 +- 52 files changed, 70 insertions(+), 65 deletions(-) diff --git a/doc/en/ref_algorithm_3DVAR.rst b/doc/en/ref_algorithm_3DVAR.rst index 633ec70..6eadd01 100644 --- a/doc/en/ref_algorithm_3DVAR.rst +++ b/doc/en/ref_algorithm_3DVAR.rst @@ -164,7 +164,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_3DVAR.rst diff --git a/doc/en/ref_algorithm_4DVAR.rst b/doc/en/ref_algorithm_4DVAR.rst index 9b2a22c..d130fb8 100644 --- a/doc/en/ref_algorithm_4DVAR.rst +++ b/doc/en/ref_algorithm_4DVAR.rst @@ -110,7 +110,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_AdjointTest.rst b/doc/en/ref_algorithm_AdjointTest.rst index 6711d71..bc0def9 100644 --- a/doc/en/ref_algorithm_AdjointTest.rst +++ b/doc/en/ref_algorithm_AdjointTest.rst @@ -94,7 +94,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_Blue.rst b/doc/en/ref_algorithm_Blue.rst index 52137fc..4e7bbda 100644 --- a/doc/en/ref_algorithm_Blue.rst +++ b/doc/en/ref_algorithm_Blue.rst @@ -139,7 +139,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_DerivativeFreeOptimization.rst b/doc/en/ref_algorithm_DerivativeFreeOptimization.rst index b53f77a..cfb6f94 100644 --- a/doc/en/ref_algorithm_DerivativeFreeOptimization.rst +++ b/doc/en/ref_algorithm_DerivativeFreeOptimization.rst @@ -108,7 +108,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_DifferentialEvolution.rst b/doc/en/ref_algorithm_DifferentialEvolution.rst index d1f1b47..e0f1d81 100644 --- a/doc/en/ref_algorithm_DifferentialEvolution.rst +++ b/doc/en/ref_algorithm_DifferentialEvolution.rst @@ -113,7 +113,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_EnsembleBlue.rst b/doc/en/ref_algorithm_EnsembleBlue.rst index 2d65e0e..fc4227b 100644 --- a/doc/en/ref_algorithm_EnsembleBlue.rst +++ b/doc/en/ref_algorithm_EnsembleBlue.rst @@ -81,7 +81,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst index 8101b32..2756ca7 100644 --- a/doc/en/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/en/ref_algorithm_EnsembleKalmanFilter.rst @@ -154,7 +154,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_EnKF.rst diff --git a/doc/en/ref_algorithm_ExtendedBlue.rst b/doc/en/ref_algorithm_ExtendedBlue.rst index e6e073a..34f4c81 100644 --- a/doc/en/ref_algorithm_ExtendedBlue.rst +++ b/doc/en/ref_algorithm_ExtendedBlue.rst @@ -124,7 +124,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst index ce2ac71..f63e526 100644 --- a/doc/en/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/en/ref_algorithm_ExtendedKalmanFilter.rst @@ -145,7 +145,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_EKF.rst diff --git a/doc/en/ref_algorithm_FunctionTest.rst b/doc/en/ref_algorithm_FunctionTest.rst index cb6e896..9fe8bea 100644 --- a/doc/en/ref_algorithm_FunctionTest.rst +++ b/doc/en/ref_algorithm_FunctionTest.rst @@ -78,7 +78,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_GradientTest.rst b/doc/en/ref_algorithm_GradientTest.rst index 40a1fae..0744063 100644 --- a/doc/en/ref_algorithm_GradientTest.rst +++ b/doc/en/ref_algorithm_GradientTest.rst @@ -129,7 +129,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_KalmanFilter.rst b/doc/en/ref_algorithm_KalmanFilter.rst index 1bf41fe..9ea11dc 100644 --- a/doc/en/ref_algorithm_KalmanFilter.rst +++ b/doc/en/ref_algorithm_KalmanFilter.rst @@ -138,7 +138,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_LinearLeastSquares.rst b/doc/en/ref_algorithm_LinearLeastSquares.rst index e4418da..74a0ad2 100644 --- a/doc/en/ref_algorithm_LinearLeastSquares.rst +++ b/doc/en/ref_algorithm_LinearLeastSquares.rst @@ -98,7 +98,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` *Tips for this algorithm:* diff --git a/doc/en/ref_algorithm_LinearityTest.rst b/doc/en/ref_algorithm_LinearityTest.rst index ef22b4f..2976e87 100644 --- a/doc/en/ref_algorithm_LinearityTest.rst +++ b/doc/en/ref_algorithm_LinearityTest.rst @@ -150,7 +150,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_LocalSensitivityTest.rst b/doc/en/ref_algorithm_LocalSensitivityTest.rst index fe63e2c..6327f71 100644 --- a/doc/en/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/en/ref_algorithm_LocalSensitivityTest.rst @@ -77,7 +77,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst index 1f2fc20..fce8a72 100644 --- a/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/en/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -46,17 +46,17 @@ Task algorithm "*MeasurementsOptimalPositioningTask*" .. include:: snippets/Header2Algo01.rst This algorithm provides optimal positioning of measurement points by an EIM -(Empirical Interpolation Method) analysis, in a iterative greedy way from a set -of given state vectors (usually called "snapshots" in reduced basis -methodology) or obtained by a direct simulation during the algorithm. Each of -these state vectors are usaully (but not necessarily) the result -:math:`\mathbf{y}` of a simulation :math:`H` for a given set of paramters -:math:`\mathbf{x}=\mu`. +(Empirical Interpolation Method) analysis. These positions are determined in a +iterative greedy way, from a pre-existing set of state vectors (usually called +"snapshots" in reduced basis methodology) or obtained by a direct simulation +during the algorithm. Each of these state vectors are usually (but not +necessarily) the result :math:`\mathbf{y}` of a simulation :math:`H` for a +given set of parameters :math:`\mathbf{x}`. There are two ways to use this algorithm: #. In its simplest use, if the set of state vectors is pre-existing, it is only - necessary to provide it by the option "*SetOfSnapshots*" of algorithm. + necessary to provide it by the algorithm option "*EnsembleOfSnapshots*". #. If the set of state vectors is to be obtained by simulations during the course of the algorithm, then one must provide the :math:`H` simulation operator and the parametric :math:`\mathbf{x}` state space design of @@ -122,7 +122,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_MOP.rst diff --git a/doc/en/ref_algorithm_NonLinearLeastSquares.rst b/doc/en/ref_algorithm_NonLinearLeastSquares.rst index 9de05a4..2ce1d6c 100644 --- a/doc/en/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/en/ref_algorithm_NonLinearLeastSquares.rst @@ -119,7 +119,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` *Tips for this algorithm:* diff --git a/doc/en/ref_algorithm_ParallelFunctionTest.rst b/doc/en/ref_algorithm_ParallelFunctionTest.rst index 701d06c..53b81f1 100644 --- a/doc/en/ref_algorithm_ParallelFunctionTest.rst +++ b/doc/en/ref_algorithm_ParallelFunctionTest.rst @@ -79,7 +79,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst index 8b4a535..b9596bc 100644 --- a/doc/en/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/en/ref_algorithm_ParticleSwarmOptimization.rst @@ -104,7 +104,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_QuantileRegression.rst b/doc/en/ref_algorithm_QuantileRegression.rst index b858d13..87c62ae 100644 --- a/doc/en/ref_algorithm_QuantileRegression.rst +++ b/doc/en/ref_algorithm_QuantileRegression.rst @@ -86,7 +86,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` *Tips for this algorithm:* diff --git a/doc/en/ref_algorithm_SamplingTest.rst b/doc/en/ref_algorithm_SamplingTest.rst index 2ddfc2f..f067bb4 100644 --- a/doc/en/ref_algorithm_SamplingTest.rst +++ b/doc/en/ref_algorithm_SamplingTest.rst @@ -106,7 +106,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_TabuSearch.rst b/doc/en/ref_algorithm_TabuSearch.rst index 4bb9bed..e19e802 100644 --- a/doc/en/ref_algorithm_TabuSearch.rst +++ b/doc/en/ref_algorithm_TabuSearch.rst @@ -113,7 +113,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_TangentTest.rst b/doc/en/ref_algorithm_TangentTest.rst index 5a8363c..e7c0ec1 100644 --- a/doc/en/ref_algorithm_TangentTest.rst +++ b/doc/en/ref_algorithm_TangentTest.rst @@ -91,7 +91,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst index 079d571..508c963 100644 --- a/doc/en/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/en/ref_algorithm_UnscentedKalmanFilter.rst @@ -127,7 +127,7 @@ StoreSupplementaryCalculations ]. Example : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_UKF.rst diff --git a/doc/en/snippets/ModuleCompatibility.rst b/doc/en/snippets/ModuleCompatibility.rst index a001843..2acdc40 100644 --- a/doc/en/snippets/ModuleCompatibility.rst +++ b/doc/en/snippets/ModuleCompatibility.rst @@ -15,6 +15,6 @@ guarantee). Python, 3.6.5, 3.10.8 Numpy, 1.14.3, 1.24.1 Scipy, 1.1.0, 1.10.0 - MatplotLib, 2.2.2, 3.6.2 + MatplotLib, 2.2.2, 3.6.3 GnuplotPy, 1.8, 1.8 NLopt, 2.4.2, 2.7.1 diff --git a/doc/fr/ref_algorithm_3DVAR.rst b/doc/fr/ref_algorithm_3DVAR.rst index 05f85f4..700527b 100644 --- a/doc/fr/ref_algorithm_3DVAR.rst +++ b/doc/fr/ref_algorithm_3DVAR.rst @@ -169,7 +169,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_3DVAR.rst diff --git a/doc/fr/ref_algorithm_4DVAR.rst b/doc/fr/ref_algorithm_4DVAR.rst index f3d76f2..818e9ae 100644 --- a/doc/fr/ref_algorithm_4DVAR.rst +++ b/doc/fr/ref_algorithm_4DVAR.rst @@ -111,7 +111,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_AdjointTest.rst b/doc/fr/ref_algorithm_AdjointTest.rst index 945b76e..c140bea 100644 --- a/doc/fr/ref_algorithm_AdjointTest.rst +++ b/doc/fr/ref_algorithm_AdjointTest.rst @@ -93,7 +93,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst index 7702f1a..a3362a3 100644 --- a/doc/fr/ref_algorithm_Blue.rst +++ b/doc/fr/ref_algorithm_Blue.rst @@ -141,7 +141,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst index 064014f..ea75f1d 100644 --- a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst +++ b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst @@ -110,7 +110,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_DifferentialEvolution.rst b/doc/fr/ref_algorithm_DifferentialEvolution.rst index 9ad239c..e8c4fcc 100644 --- a/doc/fr/ref_algorithm_DifferentialEvolution.rst +++ b/doc/fr/ref_algorithm_DifferentialEvolution.rst @@ -114,7 +114,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_EnsembleBlue.rst b/doc/fr/ref_algorithm_EnsembleBlue.rst index 6a7daf3..4b547c9 100644 --- a/doc/fr/ref_algorithm_EnsembleBlue.rst +++ b/doc/fr/ref_algorithm_EnsembleBlue.rst @@ -81,7 +81,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst index a2a8bcf..9c78cba 100644 --- a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst +++ b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst @@ -156,7 +156,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_EnKF.rst diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst index aad103a..b556d78 100644 --- a/doc/fr/ref_algorithm_ExtendedBlue.rst +++ b/doc/fr/ref_algorithm_ExtendedBlue.rst @@ -127,7 +127,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst index 7928e06..44ca126 100644 --- a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst @@ -146,7 +146,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_EKF.rst diff --git a/doc/fr/ref_algorithm_FunctionTest.rst b/doc/fr/ref_algorithm_FunctionTest.rst index e55b0ad..7c58c0a 100644 --- a/doc/fr/ref_algorithm_FunctionTest.rst +++ b/doc/fr/ref_algorithm_FunctionTest.rst @@ -79,7 +79,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_GradientTest.rst b/doc/fr/ref_algorithm_GradientTest.rst index a8c1b4f..e05e328 100644 --- a/doc/fr/ref_algorithm_GradientTest.rst +++ b/doc/fr/ref_algorithm_GradientTest.rst @@ -131,7 +131,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_KalmanFilter.rst b/doc/fr/ref_algorithm_KalmanFilter.rst index 71a0989..ec4f692 100644 --- a/doc/fr/ref_algorithm_KalmanFilter.rst +++ b/doc/fr/ref_algorithm_KalmanFilter.rst @@ -139,7 +139,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_LinearLeastSquares.rst b/doc/fr/ref_algorithm_LinearLeastSquares.rst index d00b0cc..1aa6706 100644 --- a/doc/fr/ref_algorithm_LinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_LinearLeastSquares.rst @@ -99,7 +99,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` *Astuce pour cet algorithme :* diff --git a/doc/fr/ref_algorithm_LinearityTest.rst b/doc/fr/ref_algorithm_LinearityTest.rst index dd5087f..c8b09a5 100644 --- a/doc/fr/ref_algorithm_LinearityTest.rst +++ b/doc/fr/ref_algorithm_LinearityTest.rst @@ -155,7 +155,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_LocalSensitivityTest.rst b/doc/fr/ref_algorithm_LocalSensitivityTest.rst index 2506673..79b14e1 100644 --- a/doc/fr/ref_algorithm_LocalSensitivityTest.rst +++ b/doc/fr/ref_algorithm_LocalSensitivityTest.rst @@ -78,7 +78,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst index 6da2902..e960a11 100644 --- a/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst +++ b/doc/fr/ref_algorithm_MeasurementsOptimalPositioningTask.rst @@ -25,6 +25,10 @@ .. index:: single: Positionnement optimal de mesures .. index:: single: Positions de mesures .. index:: single: Mesures (Positionnement optimal) +.. index:: single: Ensemble de simulations +.. index:: single: Ensemble de snapshots +.. index:: single: Simulations (Ensemble) +.. index:: single: Snapshots (Ensemble) .. _section_ref_algorithm_MeasurementsOptimalPositioningTask: Algorithme de tâche "*MeasurementsOptimalPositioningTask*" @@ -42,12 +46,13 @@ Algorithme de tâche "*MeasurementsOptimalPositioningTask*" .. include:: snippets/Header2Algo01.rst Cet algorithme permet d'établir la position de points de mesures optimaux par -une analyse EIM (Empirical Interpolation Method), de manière itérative à partir -d'un ensemble de vecteurs d'état établis (usuellement appelés "*snapshots*" en -méthodologie de bases réduites) ou obtenus par une simulation directe au cours -de l'algorithme. Chacun de ces vecteurs d'état est habituellement (mais pas -obligatoirement) le résultat :math:`\mathbf{y}` d'une simulation :math:`H` pour -un jeu de paramètres donné :math:`\mathbf{x}=\mu`. +une analyse EIM (Empirical Interpolation Method). Ces positions sont +déterminées de manière itérative, à partir d'un ensemble de vecteurs d'état +pré-existants (usuellement appelés "*snapshots*" en méthodologie de bases +réduites) ou obtenus par une simulation directe au cours de l'algorithme. +Chacun de ces vecteurs d'état est habituellement (mais pas obligatoirement) le +résultat :math:`\mathbf{y}` d'une simulation :math:`H` pour un jeu de +paramètres donné :math:`\mathbf{x}`. Il y a deux manières d'utiliser cet algorithme: @@ -119,7 +124,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_MOP.rst diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst index 5952dc0..4e8ec4b 100644 --- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst +++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst @@ -121,7 +121,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` *Astuce pour cet algorithme :* diff --git a/doc/fr/ref_algorithm_ParallelFunctionTest.rst b/doc/fr/ref_algorithm_ParallelFunctionTest.rst index 69170a0..85e3d89 100644 --- a/doc/fr/ref_algorithm_ParallelFunctionTest.rst +++ b/doc/fr/ref_algorithm_ParallelFunctionTest.rst @@ -80,7 +80,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst index b3662d6..f8f6899 100644 --- a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst +++ b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst @@ -105,7 +105,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_QuantileRegression.rst b/doc/fr/ref_algorithm_QuantileRegression.rst index 0c9e529..2884dfd 100644 --- a/doc/fr/ref_algorithm_QuantileRegression.rst +++ b/doc/fr/ref_algorithm_QuantileRegression.rst @@ -86,7 +86,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` *Astuce pour cet algorithme :* diff --git a/doc/fr/ref_algorithm_SamplingTest.rst b/doc/fr/ref_algorithm_SamplingTest.rst index fb7b1a2..563d2df 100644 --- a/doc/fr/ref_algorithm_SamplingTest.rst +++ b/doc/fr/ref_algorithm_SamplingTest.rst @@ -108,7 +108,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_TabuSearch.rst b/doc/fr/ref_algorithm_TabuSearch.rst index 00ff792..6957a7b 100644 --- a/doc/fr/ref_algorithm_TabuSearch.rst +++ b/doc/fr/ref_algorithm_TabuSearch.rst @@ -115,7 +115,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_TangentTest.rst b/doc/fr/ref_algorithm_TangentTest.rst index bf962a7..718a981 100644 --- a/doc/fr/ref_algorithm_TangentTest.rst +++ b/doc/fr/ref_algorithm_TangentTest.rst @@ -97,7 +97,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. ------------------------------------ .. .. include:: snippets/Header2Algo04.rst diff --git a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst index 008ea78..2cb5f43 100644 --- a/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst +++ b/doc/fr/ref_algorithm_UnscentedKalmanFilter.rst @@ -128,7 +128,7 @@ StoreSupplementaryCalculations ]. Exemple : - ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}`` .. include:: snippets/Variant_UKF.rst diff --git a/doc/fr/snippets/ModuleCompatibility.rst b/doc/fr/snippets/ModuleCompatibility.rst index b9eab33..06d4ce4 100644 --- a/doc/fr/snippets/ModuleCompatibility.rst +++ b/doc/fr/snippets/ModuleCompatibility.rst @@ -15,6 +15,6 @@ la version atteinte (mais cela reste sans garantie). Python, 3.6.5, 3.10.8 Numpy, 1.14.3, 1.24.1 Scipy, 1.1.0, 1.10.0 - MatplotLib, 2.2.2, 3.6.2 + MatplotLib, 2.2.2, 3.6.3 GnuplotPy, 1.8, 1.8 NLopt, 2.4.2, 2.7.1 -- 2.39.2