From ab2aa095b5028104218e17170acd94fdbd625298 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Fri, 6 Oct 2023 14:32:34 +0200 Subject: [PATCH] Minor documentation review corrections --- doc/en/bibliography.rst | 2 +- doc/en/snippets/APosterioriCorrelations.rst | 2 +- doc/en/snippets/APosterioriCovariance.rst | 2 +- doc/en/snippets/APosterioriStandardDeviations.rst | 2 +- doc/en/snippets/APosterioriVariances.rst | 2 +- doc/en/snippets/Analysis.rst | 2 +- doc/en/snippets/CurrentIterationNumber.rst | 2 +- doc/en/snippets/CurrentOptimum.rst | 2 +- doc/en/snippets/CurrentState.rst | 2 +- doc/en/snippets/CurrentStepNumber.rst | 2 +- doc/en/snippets/ForecastCovariance.rst | 2 +- doc/en/snippets/ForecastState.rst | 2 +- doc/en/snippets/IndexOfOptimum.rst | 2 +- doc/en/snippets/InnovationAtCurrentAnalysis.rst | 2 +- doc/en/snippets/JacobianMatrixAtBackground.rst | 2 +- doc/en/snippets/JacobianMatrixAtCurrentState.rst | 2 +- doc/en/snippets/JacobianMatrixAtOptimum.rst | 2 +- doc/en/snippets/KalmanGainAtOptimum.rst | 2 +- doc/en/snippets/MahalanobisConsistency.rst | 2 +- doc/en/snippets/Minimizer_xDVAR.rst | 6 ++++-- doc/en/snippets/OptimalLocations.rst | 14 +++++++------- doc/en/snippets/SampledStateForQuantiles.rst | 2 +- doc/en/snippets/SingularValues.rst | 3 ++- doc/en/snippets/SocialAcceleration.rst | 4 ++-- doc/en/theory.rst | 1 + doc/fr/bibliography.rst | 2 +- doc/fr/snippets/APosterioriCorrelations.rst | 2 +- doc/fr/snippets/APosterioriCovariance.rst | 2 +- doc/fr/snippets/APosterioriStandardDeviations.rst | 2 +- doc/fr/snippets/APosterioriVariances.rst | 2 +- doc/fr/snippets/Analysis.rst | 2 +- doc/fr/snippets/CurrentIterationNumber.rst | 2 +- doc/fr/snippets/CurrentOptimum.rst | 2 +- doc/fr/snippets/CurrentState.rst | 2 +- doc/fr/snippets/CurrentStepNumber.rst | 2 +- doc/fr/snippets/ForecastCovariance.rst | 2 +- doc/fr/snippets/ForecastState.rst | 2 +- doc/fr/snippets/IndexOfOptimum.rst | 2 +- doc/fr/snippets/InnovationAtCurrentAnalysis.rst | 2 +- doc/fr/snippets/JacobianMatrixAtBackground.rst | 2 +- doc/fr/snippets/JacobianMatrixAtCurrentState.rst | 2 +- doc/fr/snippets/JacobianMatrixAtOptimum.rst | 2 +- doc/fr/snippets/KalmanGainAtOptimum.rst | 2 +- doc/fr/snippets/MahalanobisConsistency.rst | 2 +- doc/fr/snippets/Minimizer_xDVAR.rst | 6 ++++-- doc/fr/snippets/OptimalLocations.rst | 13 ++++++------- doc/fr/snippets/SampledStateForQuantiles.rst | 2 +- doc/fr/snippets/SingularValues.rst | 3 ++- doc/fr/snippets/SocialAcceleration.rst | 6 +++--- doc/fr/theory.rst | 1 + src/daComposant/daAlgorithms/Atoms/ecwdeim.py | 10 ++++++++-- 51 files changed, 80 insertions(+), 67 deletions(-) diff --git a/doc/en/bibliography.rst b/doc/en/bibliography.rst index f672e6f..9e0ec18 100644 --- a/doc/en/bibliography.rst +++ b/doc/en/bibliography.rst @@ -129,7 +129,7 @@ exhaustive bibliography. .. [Python] *Python programming language*, http://www.python.org/ -.. [Quarteroni16] Quarteroni A., Manzoni A., Negri F., *Reduced Basis Methods for Partial Differential Equations - An introduction*, Springer, 2016 +.. [Quarteroni16] Quarteroni A., Manzoni A., Negri F., *Reduced Basis Methods for Partial Differential Equations - An introduction*, Unitext vol.92, Springer, 2016 .. [R] *The R Project for Statistical Computing*, http://www.r-project.org/ diff --git a/doc/en/snippets/APosterioriCorrelations.rst b/doc/en/snippets/APosterioriCorrelations.rst index 5e03b57..6c66e65 100644 --- a/doc/en/snippets/APosterioriCorrelations.rst +++ b/doc/en/snippets/APosterioriCorrelations.rst @@ -7,4 +7,4 @@ APosterioriCorrelations calculation has to be requested at the same time. Example: - ``C = ADD.get("APosterioriCorrelations")[-1]`` + ``apc = ADD.get("APosterioriCorrelations")[-1]`` diff --git a/doc/en/snippets/APosterioriCovariance.rst b/doc/en/snippets/APosterioriCovariance.rst index e0213ee..08f30d1 100644 --- a/doc/en/snippets/APosterioriCovariance.rst +++ b/doc/en/snippets/APosterioriCovariance.rst @@ -5,4 +5,4 @@ APosterioriCovariance matrix :math:`\mathbf{A}` of the optimal state. Example: - ``A = ADD.get("APosterioriCovariance")[-1]`` + ``apc = ADD.get("APosterioriCovariance")[-1]`` diff --git a/doc/en/snippets/APosterioriStandardDeviations.rst b/doc/en/snippets/APosterioriStandardDeviations.rst index eecc256..45ca430 100644 --- a/doc/en/snippets/APosterioriStandardDeviations.rst +++ b/doc/en/snippets/APosterioriStandardDeviations.rst @@ -7,4 +7,4 @@ APosterioriStandardDeviations covariances calculation has to be requested at the same time. Example: - ``S = ADD.get("APosterioriStandardDeviations")[-1]`` + ``aps = ADD.get("APosterioriStandardDeviations")[-1]`` diff --git a/doc/en/snippets/APosterioriVariances.rst b/doc/en/snippets/APosterioriVariances.rst index 6ecedd9..e8506ce 100644 --- a/doc/en/snippets/APosterioriVariances.rst +++ b/doc/en/snippets/APosterioriVariances.rst @@ -7,4 +7,4 @@ APosterioriVariances covariances calculation has to be requested at the same time. Example: - ``V = ADD.get("APosterioriVariances")[-1]`` + ``apv = ADD.get("APosterioriVariances")[-1]`` diff --git a/doc/en/snippets/Analysis.rst b/doc/en/snippets/Analysis.rst index 7054b5c..8c701db 100644 --- a/doc/en/snippets/Analysis.rst +++ b/doc/en/snippets/Analysis.rst @@ -6,4 +6,4 @@ Analysis :math:`\mathbf{x}^a` in data assimilation. Example: - ``Xa = ADD.get("Analysis")[-1]`` + ``xa = ADD.get("Analysis")[-1]`` diff --git a/doc/en/snippets/CurrentIterationNumber.rst b/doc/en/snippets/CurrentIterationNumber.rst index 2c8ed6c..c14edba 100644 --- a/doc/en/snippets/CurrentIterationNumber.rst +++ b/doc/en/snippets/CurrentIterationNumber.rst @@ -6,4 +6,4 @@ CurrentIterationNumber per assimilation step corresponding to an observed state. Example: - ``i = ADD.get("CurrentIterationNumber")[-1]`` + ``cin = ADD.get("CurrentIterationNumber")[-1]`` diff --git a/doc/en/snippets/CurrentOptimum.rst b/doc/en/snippets/CurrentOptimum.rst index 6fa0e62..cb1ed55 100644 --- a/doc/en/snippets/CurrentOptimum.rst +++ b/doc/en/snippets/CurrentOptimum.rst @@ -6,4 +6,4 @@ CurrentOptimum is not necessarily the last state. Example: - ``Xo = ADD.get("CurrentOptimum")[:]`` + ``xo = ADD.get("CurrentOptimum")[:]`` diff --git a/doc/en/snippets/CurrentState.rst b/doc/en/snippets/CurrentState.rst index ae59499..39bff6c 100644 --- a/doc/en/snippets/CurrentState.rst +++ b/doc/en/snippets/CurrentState.rst @@ -5,4 +5,4 @@ CurrentState iterative algorithm procedure. Example: - ``Xs = ADD.get("CurrentState")[:]`` + ``xs = ADD.get("CurrentState")[:]`` diff --git a/doc/en/snippets/CurrentStepNumber.rst b/doc/en/snippets/CurrentStepNumber.rst index 2a42555..8d61ee5 100644 --- a/doc/en/snippets/CurrentStepNumber.rst +++ b/doc/en/snippets/CurrentStepNumber.rst @@ -8,4 +8,4 @@ CurrentStepNumber non-iterative algorithms. Example: - ``i = ADD.get("CurrentStepNumber")[-1]`` + ``csn = ADD.get("CurrentStepNumber")[-1]`` diff --git a/doc/en/snippets/ForecastCovariance.rst b/doc/en/snippets/ForecastCovariance.rst index e2bc302..f19b317 100644 --- a/doc/en/snippets/ForecastCovariance.rst +++ b/doc/en/snippets/ForecastCovariance.rst @@ -6,4 +6,4 @@ ForecastCovariance used. Example : - ``Pf = ADD.get("ForecastCovariance")[-1]`` + ``pf = ADD.get("ForecastCovariance")[-1]`` diff --git a/doc/en/snippets/ForecastState.rst b/doc/en/snippets/ForecastState.rst index c14af8e..d0c54fd 100644 --- a/doc/en/snippets/ForecastState.rst +++ b/doc/en/snippets/ForecastState.rst @@ -5,4 +5,4 @@ ForecastState during the iterative algorithm procedure. Example: - ``Xp = ADD.get("ForecastState")[:]`` + ``xf = ADD.get("ForecastState")[:]`` diff --git a/doc/en/snippets/IndexOfOptimum.rst b/doc/en/snippets/IndexOfOptimum.rst index 8d880ca..820e2c4 100644 --- a/doc/en/snippets/IndexOfOptimum.rst +++ b/doc/en/snippets/IndexOfOptimum.rst @@ -7,4 +7,4 @@ IndexOfOptimum iteration. Example: - ``i = ADD.get("IndexOfOptimum")[-1]`` + ``ioo = ADD.get("IndexOfOptimum")[-1]`` diff --git a/doc/en/snippets/InnovationAtCurrentAnalysis.rst b/doc/en/snippets/InnovationAtCurrentAnalysis.rst index 652b366..9372e51 100644 --- a/doc/en/snippets/InnovationAtCurrentAnalysis.rst +++ b/doc/en/snippets/InnovationAtCurrentAnalysis.rst @@ -6,4 +6,4 @@ InnovationAtCurrentAnalysis case of a single-state assimilation. Example: - ``ds = ADD.get("InnovationAtCurrentAnalysis")[-1]`` + ``da = ADD.get("InnovationAtCurrentAnalysis")[-1]`` diff --git a/doc/en/snippets/JacobianMatrixAtBackground.rst b/doc/en/snippets/JacobianMatrixAtBackground.rst index 4ae42b1..0b37385 100644 --- a/doc/en/snippets/JacobianMatrixAtBackground.rst +++ b/doc/en/snippets/JacobianMatrixAtBackground.rst @@ -7,4 +7,4 @@ JacobianMatrixAtBackground at the initial state. Example: - ``GradH = ADD.get("JacobianMatrixAtBackground")[-1]`` + ``gradh = ADD.get("JacobianMatrixAtBackground")[-1]`` diff --git a/doc/en/snippets/JacobianMatrixAtCurrentState.rst b/doc/en/snippets/JacobianMatrixAtCurrentState.rst index 0a6984d..e75a05b 100644 --- a/doc/en/snippets/JacobianMatrixAtCurrentState.rst +++ b/doc/en/snippets/JacobianMatrixAtCurrentState.rst @@ -7,4 +7,4 @@ JacobianMatrixAtCurrentState current state. Example: - ``GradH = ADD.get("JacobianMatrixAtCurrentState")[-1]`` + ``gradh = ADD.get("JacobianMatrixAtCurrentState")[-1]`` diff --git a/doc/en/snippets/JacobianMatrixAtOptimum.rst b/doc/en/snippets/JacobianMatrixAtOptimum.rst index b2487e2..7c79e11 100644 --- a/doc/en/snippets/JacobianMatrixAtOptimum.rst +++ b/doc/en/snippets/JacobianMatrixAtOptimum.rst @@ -7,4 +7,4 @@ JacobianMatrixAtOptimum at the optimal state. Example: - ``GradH = ADD.get("JacobianMatrixAtOptimum")[-1]`` + ``gradh = ADD.get("JacobianMatrixAtOptimum")[-1]`` diff --git a/doc/en/snippets/KalmanGainAtOptimum.rst b/doc/en/snippets/KalmanGainAtOptimum.rst index bd76582..3030006 100644 --- a/doc/en/snippets/KalmanGainAtOptimum.rst +++ b/doc/en/snippets/KalmanGainAtOptimum.rst @@ -6,4 +6,4 @@ KalmanGainAtOptimum state. Example: - ``KG = ADD.get("KalmanGainAtOptimum")[-1]`` + ``kg = ADD.get("KalmanGainAtOptimum")[-1]`` diff --git a/doc/en/snippets/MahalanobisConsistency.rst b/doc/en/snippets/MahalanobisConsistency.rst index a01f2a9..f88202e 100644 --- a/doc/en/snippets/MahalanobisConsistency.rst +++ b/doc/en/snippets/MahalanobisConsistency.rst @@ -5,4 +5,4 @@ MahalanobisConsistency indicator. Example: - ``m = ADD.get("MahalanobisConsistency")[-1]`` + ``mc = ADD.get("MahalanobisConsistency")[-1]`` diff --git a/doc/en/snippets/Minimizer_xDVAR.rst b/doc/en/snippets/Minimizer_xDVAR.rst index c412afa..08a855c 100644 --- a/doc/en/snippets/Minimizer_xDVAR.rst +++ b/doc/en/snippets/Minimizer_xDVAR.rst @@ -4,7 +4,8 @@ pair: Minimizer ; TNC pair: Minimizer ; CG pair: Minimizer ; BFGS - pair: Minimizer ; NCG + +.. pair: Minimizer ; NCG Minimizer *Predefined name*. This key allows to choose the optimization minimizer. The @@ -13,8 +14,9 @@ Minimizer "TNC" (nonlinear constrained minimizer), "CG" (nonlinear unconstrained minimizer), "BFGS" (nonlinear unconstrained minimizer), - "NCG" (Newton CG minimizer). It is strongly recommended to stay with the default. +.. "NCG" (Newton CG minimizer). + Example : ``{"Minimizer":"LBFGSB"}`` diff --git a/doc/en/snippets/OptimalLocations.rst b/doc/en/snippets/OptimalLocations.rst index e3ef486..8017d5c 100644 --- a/doc/en/snippets/OptimalLocations.rst +++ b/doc/en/snippets/OptimalLocations.rst @@ -1,11 +1,11 @@ .. index:: single: OptimalLocations OptimalLocations - *List of integer series*. Each element is a series, containing the indices of - ideal positions or optimal points where a measurement is required, in the - order of the variables of a state vector considered arbitrarily in - one-dimensional form, and in the same order as the vectors of the reduced - basis found iteratively. + *Integer series*. This series contains the indices of ideal positions or + optimal points where a measurement is required, in the order of the variables + of a state vector considered arbitrarily in one-dimensional form, and in the + same order as the vectors of the reduced basis found iteratively. - It is identical to a single output of the ideal positions or optimum points - of a :ref:`section_ref_algorithm_MeasurementsOptimalPositioningTask`. + It is identical to a single output (one single series) of the ideal positions + or optimum points (which is a list of integer series) of a + :ref:`section_ref_algorithm_MeasurementsOptimalPositioningTask`. diff --git a/doc/en/snippets/SampledStateForQuantiles.rst b/doc/en/snippets/SampledStateForQuantiles.rst index c571e59..5790bdb 100644 --- a/doc/en/snippets/SampledStateForQuantiles.rst +++ b/doc/en/snippets/SampledStateForQuantiles.rst @@ -7,4 +7,4 @@ SampledStateForQuantiles required for this quantile estimate. Example : - ``Xq = ADD.get("SampledStateForQuantiles")[:]`` + ``xq = ADD.get("SampledStateForQuantiles")[:]`` diff --git a/doc/en/snippets/SingularValues.rst b/doc/en/snippets/SingularValues.rst index 1101946..1766bd6 100644 --- a/doc/en/snippets/SingularValues.rst +++ b/doc/en/snippets/SingularValues.rst @@ -3,7 +3,8 @@ SingularValues *List of real value series*. Each element is a series, containing the singular values obtained through a SVD decomposition of a collection of full - state vectors. + state vectors. The number of singular values is not limited by the requested + size of the reduced basis. Example : ``sv = ADD.get("SingularValues")[-1]`` diff --git a/doc/en/snippets/SocialAcceleration.rst b/doc/en/snippets/SocialAcceleration.rst index b1114bc..11e4b98 100644 --- a/doc/en/snippets/SocialAcceleration.rst +++ b/doc/en/snippets/SocialAcceleration.rst @@ -4,8 +4,8 @@ SocialAcceleration *Real value*. This key indicates the recall rate at the best swarm insect in the neighbourhood of the current insect, which is by default the whole swarm. It is a floating point positive value. The default value is about - :math:`1/2+ln(2)` and it is recommended to adapt it, rather by reducing it, - to the physical case that is being treated. + :math:`1/2+ln(2)=1.19315` and it is recommended to adapt it, rather by + reducing it, to the physical case that is being treated. Example : ``{"SocialAcceleration":1.19315}`` diff --git a/doc/en/theory.rst b/doc/en/theory.rst index d6bf464..dc2da5b 100644 --- a/doc/en/theory.rst +++ b/doc/en/theory.rst @@ -369,6 +369,7 @@ An overview of reduction methods and of reduced optimization .. index:: single: PCA .. index:: single: Kahrunen-Loeve .. index:: single: RBM +.. index:: single: ROM .. index:: single: EIM .. index:: single: Fourier .. index:: single: wavelets diff --git a/doc/fr/bibliography.rst b/doc/fr/bibliography.rst index dc6f0d1..254966a 100644 --- a/doc/fr/bibliography.rst +++ b/doc/fr/bibliography.rst @@ -129,7 +129,7 @@ néanmoins d'intention de constituer une bibliographie exhaustive. .. [Python] *Python programming language*, http://www.python.org/ -.. [Quarteroni16] Quarteroni A., Manzoni A., Negri F., *Reduced Basis Methods for Partial Differential Equations - An introduction*, Springer, 2016 +.. [Quarteroni16] Quarteroni A., Manzoni A., Negri F., *Reduced Basis Methods for Partial Differential Equations - An introduction*, Unitext vol.92, Springer, 2016 .. [R] *The R Project for Statistical Computing*, http://www.r-project.org/ diff --git a/doc/fr/snippets/APosterioriCorrelations.rst b/doc/fr/snippets/APosterioriCorrelations.rst index d99d4c5..5cb8357 100644 --- a/doc/fr/snippets/APosterioriCorrelations.rst +++ b/doc/fr/snippets/APosterioriCorrelations.rst @@ -7,4 +7,4 @@ APosterioriCorrelations temps demandé le calcul de ces covariances d'erreurs *a posteriori*. Exemple : - ``C = ADD.get("APosterioriCorrelations")[-1]`` + ``apc = ADD.get("APosterioriCorrelations")[-1]`` diff --git a/doc/fr/snippets/APosterioriCovariance.rst b/doc/fr/snippets/APosterioriCovariance.rst index 22c0147..9fa6dd1 100644 --- a/doc/fr/snippets/APosterioriCovariance.rst +++ b/doc/fr/snippets/APosterioriCovariance.rst @@ -5,4 +5,4 @@ APosterioriCovariance covariances des erreurs *a posteriori* de l'état optimal. Exemple : - ``A = ADD.get("APosterioriCovariance")[-1]`` + ``apc = ADD.get("APosterioriCovariance")[-1]`` diff --git a/doc/fr/snippets/APosterioriStandardDeviations.rst b/doc/fr/snippets/APosterioriStandardDeviations.rst index 0d9ab40..2cdcc58 100644 --- a/doc/fr/snippets/APosterioriStandardDeviations.rst +++ b/doc/fr/snippets/APosterioriStandardDeviations.rst @@ -7,4 +7,4 @@ APosterioriStandardDeviations temps demandé le calcul de ces covariances d'erreurs *a posteriori*. Exemple : - ``S = ADD.get("APosterioriStandardDeviations")[-1]`` + ``aps = ADD.get("APosterioriStandardDeviations")[-1]`` diff --git a/doc/fr/snippets/APosterioriVariances.rst b/doc/fr/snippets/APosterioriVariances.rst index b8a5db4..2b05e3b 100644 --- a/doc/fr/snippets/APosterioriVariances.rst +++ b/doc/fr/snippets/APosterioriVariances.rst @@ -7,4 +7,4 @@ APosterioriVariances temps demandé le calcul de ces covariances d'erreurs *a posteriori*. Exemple : - ``V = ADD.get("APosterioriVariances")[-1]`` + ``apv = ADD.get("APosterioriVariances")[-1]`` diff --git a/doc/fr/snippets/Analysis.rst b/doc/fr/snippets/Analysis.rst index df397eb..cb96f04 100644 --- a/doc/fr/snippets/Analysis.rst +++ b/doc/fr/snippets/Analysis.rst @@ -6,4 +6,4 @@ Analysis :math:`\mathbf{x}^a` en assimilation de données. Exemple : - ``Xa = ADD.get("Analysis")[-1]`` + ``xa = ADD.get("Analysis")[-1]`` diff --git a/doc/fr/snippets/CurrentIterationNumber.rst b/doc/fr/snippets/CurrentIterationNumber.rst index 81548f4..1fe6ac6 100644 --- a/doc/fr/snippets/CurrentIterationNumber.rst +++ b/doc/fr/snippets/CurrentIterationNumber.rst @@ -6,4 +6,4 @@ CurrentIterationNumber d'itération par pas d'assimilation correspondant à un état observé. Exemple : - ``i = ADD.get("CurrentIterationNumber")[-1]`` + ``cin = ADD.get("CurrentIterationNumber")[-1]`` diff --git a/doc/fr/snippets/CurrentOptimum.rst b/doc/fr/snippets/CurrentOptimum.rst index 481bc18..d580a89 100644 --- a/doc/fr/snippets/CurrentOptimum.rst +++ b/doc/fr/snippets/CurrentOptimum.rst @@ -6,4 +6,4 @@ CurrentOptimum utilisé. Ce n'est pas nécessairement le dernier état. Exemple : - ``Xo = ADD.get("CurrentOptimum")[:]`` + ``xo = ADD.get("CurrentOptimum")[:]`` diff --git a/doc/fr/snippets/CurrentState.rst b/doc/fr/snippets/CurrentState.rst index 672599d..520af00 100644 --- a/doc/fr/snippets/CurrentState.rst +++ b/doc/fr/snippets/CurrentState.rst @@ -5,4 +5,4 @@ CurrentState au cours du déroulement itératif de l'algorithme utilisé. Exemple : - ``Xs = ADD.get("CurrentState")[:]`` + ``xs = ADD.get("CurrentState")[:]`` diff --git a/doc/fr/snippets/CurrentStepNumber.rst b/doc/fr/snippets/CurrentStepNumber.rst index 69fdc06..4e308d8 100644 --- a/doc/fr/snippets/CurrentStepNumber.rst +++ b/doc/fr/snippets/CurrentStepNumber.rst @@ -8,4 +8,4 @@ CurrentStepNumber algorithmes non itératifs. Exemple : - ``i = ADD.get("CurrentStepNumber")[-1]`` + ``csn = ADD.get("CurrentStepNumber")[-1]`` diff --git a/doc/fr/snippets/ForecastCovariance.rst b/doc/fr/snippets/ForecastCovariance.rst index 81d5dea..855b763 100644 --- a/doc/fr/snippets/ForecastCovariance.rst +++ b/doc/fr/snippets/ForecastCovariance.rst @@ -6,4 +6,4 @@ ForecastCovariance l'algorithme utilisé. Exemple : - ``Pf = ADD.get("ForecastCovariance")[-1]`` + ``pf = ADD.get("ForecastCovariance")[-1]`` diff --git a/doc/fr/snippets/ForecastState.rst b/doc/fr/snippets/ForecastState.rst index 0e4a173..7cce983 100644 --- a/doc/fr/snippets/ForecastState.rst +++ b/doc/fr/snippets/ForecastState.rst @@ -6,4 +6,4 @@ ForecastState déroulement itératif temporel de l'algorithme utilisé. Exemple : - ``Xf = ADD.get("ForecastState")[:]`` + ``xf = ADD.get("ForecastState")[:]`` diff --git a/doc/fr/snippets/IndexOfOptimum.rst b/doc/fr/snippets/IndexOfOptimum.rst index 2381edc..f678e61 100644 --- a/doc/fr/snippets/IndexOfOptimum.rst +++ b/doc/fr/snippets/IndexOfOptimum.rst @@ -6,4 +6,4 @@ IndexOfOptimum n'est pas nécessairement le numéro de la dernière itération. Exemple : - ``i = ADD.get("IndexOfOptimum")[-1]`` + ``ioo = ADD.get("IndexOfOptimum")[-1]`` diff --git a/doc/fr/snippets/InnovationAtCurrentAnalysis.rst b/doc/fr/snippets/InnovationAtCurrentAnalysis.rst index f8e319c..84fb671 100644 --- a/doc/fr/snippets/InnovationAtCurrentAnalysis.rst +++ b/doc/fr/snippets/InnovationAtCurrentAnalysis.rst @@ -6,4 +6,4 @@ InnovationAtCurrentAnalysis l'état analysé dans le cas d'une assimilation mono-état. Exemple : - ``ds = ADD.get("InnovationAtCurrentAnalysis")[-1]`` + ``da = ADD.get("InnovationAtCurrentAnalysis")[-1]`` diff --git a/doc/fr/snippets/JacobianMatrixAtBackground.rst b/doc/fr/snippets/JacobianMatrixAtBackground.rst index 998177f..2cac11b 100644 --- a/doc/fr/snippets/JacobianMatrixAtBackground.rst +++ b/doc/fr/snippets/JacobianMatrixAtBackground.rst @@ -7,4 +7,4 @@ JacobianMatrixAtBackground effectué à l'état initial. Exemple: - ``GradH = ADD.get("JacobianMatrixAtBackground")[-1]`` + ``gradh = ADD.get("JacobianMatrixAtBackground")[-1]`` diff --git a/doc/fr/snippets/JacobianMatrixAtCurrentState.rst b/doc/fr/snippets/JacobianMatrixAtCurrentState.rst index 86f52cd..a663b94 100644 --- a/doc/fr/snippets/JacobianMatrixAtCurrentState.rst +++ b/doc/fr/snippets/JacobianMatrixAtCurrentState.rst @@ -7,4 +7,4 @@ JacobianMatrixAtCurrentState effectué à l'état courant. Exemple: - ``GradH = ADD.get("JacobianMatrixAtCurrentState")[-1]`` + ``gradh = ADD.get("JacobianMatrixAtCurrentState")[-1]`` diff --git a/doc/fr/snippets/JacobianMatrixAtOptimum.rst b/doc/fr/snippets/JacobianMatrixAtOptimum.rst index b741945..fd5f7d7 100644 --- a/doc/fr/snippets/JacobianMatrixAtOptimum.rst +++ b/doc/fr/snippets/JacobianMatrixAtOptimum.rst @@ -7,4 +7,4 @@ JacobianMatrixAtOptimum effectué à l'état optimal. Exemple: - ``GradH = ADD.get("JacobianMatrixAtOptimum")[-1]`` + ``gradh = ADD.get("JacobianMatrixAtOptimum")[-1]`` diff --git a/doc/fr/snippets/KalmanGainAtOptimum.rst b/doc/fr/snippets/KalmanGainAtOptimum.rst index 7c946f5..e74e90b 100644 --- a/doc/fr/snippets/KalmanGainAtOptimum.rst +++ b/doc/fr/snippets/KalmanGainAtOptimum.rst @@ -6,4 +6,4 @@ KalmanGainAtOptimum est effectué à l'état optimal. Exemple: - ``KG = ADD.get("KalmanGainAtOptimum")[-1]`` + ``kg = ADD.get("KalmanGainAtOptimum")[-1]`` diff --git a/doc/fr/snippets/MahalanobisConsistency.rst b/doc/fr/snippets/MahalanobisConsistency.rst index 77717d7..c05f1be 100644 --- a/doc/fr/snippets/MahalanobisConsistency.rst +++ b/doc/fr/snippets/MahalanobisConsistency.rst @@ -5,4 +5,4 @@ MahalanobisConsistency qualité de Mahalanobis. Exemple : - ``m = ADD.get("MahalanobisConsistency")[-1]`` + ``mc = ADD.get("MahalanobisConsistency")[-1]`` diff --git a/doc/fr/snippets/Minimizer_xDVAR.rst b/doc/fr/snippets/Minimizer_xDVAR.rst index 6eec587..61d2cd3 100644 --- a/doc/fr/snippets/Minimizer_xDVAR.rst +++ b/doc/fr/snippets/Minimizer_xDVAR.rst @@ -4,7 +4,8 @@ pair: Minimizer ; TNC pair: Minimizer ; CG pair: Minimizer ; BFGS - pair: Minimizer ; NCG + +.. pair: Minimizer ; NCG Minimizer *Nom prédéfini*. Cette clé permet de changer le minimiseur pour l'optimiseur. @@ -13,8 +14,9 @@ Minimizer "TNC" (minimisation non linéaire sous contraintes), "CG" (minimisation non linéaire sans contraintes), "BFGS" (minimisation non linéaire sans contraintes), - "NCG" (minimisation de type gradient conjugué de Newton). Il est fortement conseillé de conserver la valeur par défaut. +.. "NCG" (minimisation de type gradient conjugué de Newton). + Exemple : ``{"Minimizer":"LBFGSB"}`` diff --git a/doc/fr/snippets/OptimalLocations.rst b/doc/fr/snippets/OptimalLocations.rst index 0a2386f..ae8b6dc 100644 --- a/doc/fr/snippets/OptimalLocations.rst +++ b/doc/fr/snippets/OptimalLocations.rst @@ -1,12 +1,11 @@ .. index:: single: OptimalLocations OptimalLocations - *Liste de série d'entiers*. Chaque élément est une série, contenant les - indices des positions idéales ou points optimaux auxquels une mesure est - requise, selon l'ordre des variables d'un vecteur d'état considéré - arbitrairement sous forme unidimensionnelle, et dans le même ordre que les - vecteurs de la base réduite trouvés itérativement. + *Série d'entiers*. Cette série contient les indices des positions idéales ou + points optimaux auxquels une mesure est requise, selon l'ordre des variables + d'un vecteur d'état considéré arbitrairement sous forme unidimensionnelle, et + dans le même ordre que les vecteurs de la base réduite trouvés itérativement. - Elle est identique à une sortie unique des positions idéales ou points - optimaux d'un + Elle est identique à une sortie unique (une seule série) des positions + idéales ou points optimaux (qui est une liste de séries d'entiers) d'un :ref:`section_ref_algorithm_MeasurementsOptimalPositioningTask`. diff --git a/doc/fr/snippets/SampledStateForQuantiles.rst b/doc/fr/snippets/SampledStateForQuantiles.rst index b2226ec..bfd4753 100644 --- a/doc/fr/snippets/SampledStateForQuantiles.rst +++ b/doc/fr/snippets/SampledStateForQuantiles.rst @@ -7,4 +7,4 @@ SampledStateForQuantiles nombre d'échantillons requis pour cette estimation de quantiles. Exemple : - ``Xq = ADD.get("SampledStateForQuantiles")[:]`` + ``xq = ADD.get("SampledStateForQuantiles")[:]`` diff --git a/doc/fr/snippets/SingularValues.rst b/doc/fr/snippets/SingularValues.rst index 5c0c851..40fc000 100644 --- a/doc/fr/snippets/SingularValues.rst +++ b/doc/fr/snippets/SingularValues.rst @@ -3,7 +3,8 @@ SingularValues *Liste de série de valeurs réelles*. Chaque élément est une série, contenant les valeurs singulières obtenues par une décomposition SVD d'un ensemble de - vecteurs d'états complets. + vecteurs d'états complets. Le nombre de valeurs singulières retenues n'est + pas limité par la taille de la base réduite demandée. Exemple : ``sv = ADD.get("SingularValues")[-1]`` diff --git a/doc/fr/snippets/SocialAcceleration.rst b/doc/fr/snippets/SocialAcceleration.rst index 6353103..c537b2d 100644 --- a/doc/fr/snippets/SocialAcceleration.rst +++ b/doc/fr/snippets/SocialAcceleration.rst @@ -3,9 +3,9 @@ SocialAcceleration *Valeur réelle*. Cette clé indique le taux de rappel vers le meilleur insecte du voisinage de l'insecte courant, qui est par défaut l'essaim complet. C'est - une valeur réelle positive. Le défaut est à peu près de :math:`1/2+ln(2)` et - il est recommandé de l'adapter, plutôt en le réduisant, au cas physique qui - est en traitement. + une valeur réelle positive. Le défaut est à peu près de + :math:`1/2+ln(2)=1.19315` et il est recommandé de l'adapter, plutôt en le + réduisant, au cas physique qui est en traitement. Exemple : ``{"SocialAcceleration":1.19315}`` diff --git a/doc/fr/theory.rst b/doc/fr/theory.rst index 326a517..6da0912 100644 --- a/doc/fr/theory.rst +++ b/doc/fr/theory.rst @@ -392,6 +392,7 @@ Un aperçu des méthodes de réduction et de l'optimisation réduite .. index:: single: PCA .. index:: single: Kahrunen-Loeve .. index:: single: RBM +.. index:: single: ROM .. index:: single: EIM .. index:: single: Fourier .. index:: single: ondelettes diff --git a/src/daComposant/daAlgorithms/Atoms/ecwdeim.py b/src/daComposant/daAlgorithms/Atoms/ecwdeim.py index cb79f6f..4415177 100644 --- a/src/daComposant/daAlgorithms/Atoms/ecwdeim.py +++ b/src/daComposant/daAlgorithms/Atoms/ecwdeim.py @@ -28,6 +28,7 @@ __author__ = "Jean-Philippe ARGAUD" import numpy, scipy, logging import daCore.Persistence from daCore.NumericObjects import FindIndexesFromNames +from daCore.PlatformInfo import vt # ============================================================================== def DEIM_offline(selfA, EOS = None, Verbose = False): @@ -87,8 +88,13 @@ def DEIM_offline(selfA, EOS = None, Verbose = False): else: selfA._parameters["EpsilonEIM"] = 1.e-2 # - __U, __vs, _ = scipy.linalg.svd( __EOS ) - __rhoM = numpy.compress(__vs > selfA._parameters["EpsilonEIM"], __U, axis=1) + # Ne pas utiliser : scipy.linalg.svd + __vs = scipy.linalg.svdvals( __EOS ) + if vt(scipy.version.version) < vt("1.1.0"): + __rhoM = scipy.linalg.orth( __EOS ) + __rhoM = numpy.compress(__vs > selfA._parameters["EpsilonEIM"]*max(__vs), __rhoM, axis=1) + else: + __rhoM = scipy.linalg.orth( __EOS, selfA._parameters["EpsilonEIM"] ) __lVs, __svdM = __rhoM.shape assert __lVs == __dimS, "Différence entre lVs et dim(EOS)" __qivs = (1. - __vs[:__svdM].cumsum()/__vs.sum()) -- 2.39.2