From eee642021cda608711fb321070bebc5250a13026 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Fri, 3 Aug 2018 18:23:14 +0200 Subject: [PATCH] Minor documentation corrections --- 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/AmplitudeOfInitialDirection.rst | 2 +- doc/en/snippets/Analysis.rst | 2 +- doc/en/snippets/BMA.rst | 2 +- doc/en/snippets/BoundsWithExtremes.rst | 2 +- doc/en/snippets/BoundsWithNone.rst | 2 +- doc/en/snippets/ConstrainedBy.rst | 2 +- doc/en/snippets/CostDecrementTolerance.rst | 2 +- doc/en/snippets/CostDecrementTolerance_6.rst | 3 ++- doc/en/snippets/CostFunctionJ.rst | 2 +- doc/en/snippets/CostFunctionJAtCurrentOptimum.rst | 2 +- doc/en/snippets/CostFunctionJb.rst | 2 +- doc/en/snippets/CostFunctionJbAtCurrentOptimum.rst | 2 +- doc/en/snippets/CostFunctionJo.rst | 2 +- doc/en/snippets/CostFunctionJoAtCurrentOptimum.rst | 2 +- doc/en/snippets/CurrentOptimum.rst | 2 +- doc/en/snippets/CurrentState.rst | 2 +- doc/en/snippets/EpsilonMinimumExponent.rst | 2 +- doc/en/snippets/EstimationOf.rst | 2 +- doc/en/snippets/GradientNormTolerance.rst | 2 +- doc/en/snippets/IndexOfOptimum.rst | 2 +- doc/en/snippets/InitialDirection.rst | 2 +- doc/en/snippets/Innovation.rst | 2 +- doc/en/snippets/InnovationAtCurrentState.rst | 2 +- doc/en/snippets/MahalanobisConsistency.rst | 2 +- doc/en/snippets/MaximumNumberOfFunctionEvaluations.rst | 2 +- doc/en/snippets/MaximumNumberOfSteps.rst | 2 +- doc/en/snippets/MaximumNumberOfSteps_50.rst | 2 +- doc/en/snippets/Minimizer_DFO.rst | 2 +- doc/en/snippets/NumberOfMembers.rst | 2 +- doc/en/snippets/NumberOfPrintedDigits.rst | 2 +- doc/en/snippets/NumberOfRepetition.rst | 2 +- doc/en/snippets/NumberOfSamplesForQuantiles.rst | 2 +- doc/en/snippets/OMA.rst | 2 +- doc/en/snippets/OMB.rst | 2 +- doc/en/snippets/ProjectedGradientTolerance.rst | 2 +- doc/en/snippets/QualityCriterion.rst | 2 +- doc/en/snippets/Quantile.rst | 2 +- doc/en/snippets/Quantiles.rst | 2 +- doc/en/snippets/Residu.rst | 2 +- doc/en/snippets/SetDebug.rst | 2 +- doc/en/snippets/SetSeed.rst | 2 +- doc/en/snippets/SigmaBck2.rst | 2 +- doc/en/snippets/SigmaObs2.rst | 2 +- doc/en/snippets/SimulatedObservationAtBackground.rst | 2 +- doc/en/snippets/SimulatedObservationAtCurrentOptimum.rst | 2 +- doc/en/snippets/SimulatedObservationAtCurrentState.rst | 2 +- doc/en/snippets/SimulatedObservationAtOptimum.rst | 2 +- doc/en/snippets/SimulationForQuantiles.rst | 2 +- doc/en/snippets/SimulationQuantiles.rst | 2 +- doc/en/snippets/StateVariationTolerance.rst | 2 +- 54 files changed, 55 insertions(+), 54 deletions(-) diff --git a/doc/en/snippets/APosterioriCorrelations.rst b/doc/en/snippets/APosterioriCorrelations.rst index eba27eb..9a56396 100644 --- a/doc/en/snippets/APosterioriCorrelations.rst +++ b/doc/en/snippets/APosterioriCorrelations.rst @@ -5,5 +5,5 @@ APosterioriCorrelations matrix of the optimal state, coming from the :math:`\mathbf{A}*` covariance matrix. - Example : + Example: ``C = ADD.get("APosterioriCorrelations")[-1]`` diff --git a/doc/en/snippets/APosterioriCovariance.rst b/doc/en/snippets/APosterioriCovariance.rst index 5c13b59..17d1193 100644 --- a/doc/en/snippets/APosterioriCovariance.rst +++ b/doc/en/snippets/APosterioriCovariance.rst @@ -4,5 +4,5 @@ APosterioriCovariance *List of matrices*. Each element is an *a posteriori* error covariance matrix :math:`\mathbf{A}*` of the optimal state. - Example : + Example: ``A = ADD.get("APosterioriCovariance")[-1]`` diff --git a/doc/en/snippets/APosterioriStandardDeviations.rst b/doc/en/snippets/APosterioriStandardDeviations.rst index 5ec2ddb..8d8684b 100644 --- a/doc/en/snippets/APosterioriStandardDeviations.rst +++ b/doc/en/snippets/APosterioriStandardDeviations.rst @@ -5,5 +5,5 @@ APosterioriStandardDeviations errors diagonal matrix of the optimal state, coming from the :math:`\mathbf{A}*` covariance matrix. - Example : + Example: ``S = ADD.get("APosterioriStandardDeviations")[-1]`` diff --git a/doc/en/snippets/APosterioriVariances.rst b/doc/en/snippets/APosterioriVariances.rst index 89e3141..0105d05 100644 --- a/doc/en/snippets/APosterioriVariances.rst +++ b/doc/en/snippets/APosterioriVariances.rst @@ -5,5 +5,5 @@ APosterioriVariances errors diagonal matrix of the optimal state, coming from the :math:`\mathbf{A}*` covariance matrix. - Example : + Example: ``V = ADD.get("APosterioriVariances")[-1]`` diff --git a/doc/en/snippets/AmplitudeOfInitialDirection.rst b/doc/en/snippets/AmplitudeOfInitialDirection.rst index b473d1c..b9a53e8 100644 --- a/doc/en/snippets/AmplitudeOfInitialDirection.rst +++ b/doc/en/snippets/AmplitudeOfInitialDirection.rst @@ -5,5 +5,5 @@ AmplitudeOfInitialDirection used for the directional derivative around the nominal checking point. The default is 1, that means no scaling. - Example : + Example: ``{"AmplitudeOfInitialDirection":0.5}`` diff --git a/doc/en/snippets/Analysis.rst b/doc/en/snippets/Analysis.rst index 1e1d9de..4592be4 100644 --- a/doc/en/snippets/Analysis.rst +++ b/doc/en/snippets/Analysis.rst @@ -5,5 +5,5 @@ Analysis :math:`\mathbf{x}*` in optimization or an analysis :math:`\mathbf{x}^a` in data assimilation. - Example : + Example: ``Xa = ADD.get("Analysis")[-1]`` diff --git a/doc/en/snippets/BMA.rst b/doc/en/snippets/BMA.rst index 69b0ec8..60f334b 100644 --- a/doc/en/snippets/BMA.rst +++ b/doc/en/snippets/BMA.rst @@ -4,5 +4,5 @@ BMA *List of vectors*. Each element is a vector of difference between the background and the optimal state. - Example : + Example: ``bma = ADD.get("BMA")[-1]`` diff --git a/doc/en/snippets/BoundsWithExtremes.rst b/doc/en/snippets/BoundsWithExtremes.rst index cc7259e..a1ebb34 100644 --- a/doc/en/snippets/BoundsWithExtremes.rst +++ b/doc/en/snippets/BoundsWithExtremes.rst @@ -6,5 +6,5 @@ Bounds lower/upper bounds for each variable, with extreme values every time there is no bound (``None`` is not allowed when there is no bound). - Example : + Example: ``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,1.e99],[-1.e99,1.e99]]}`` diff --git a/doc/en/snippets/BoundsWithNone.rst b/doc/en/snippets/BoundsWithNone.rst index 1fb608c..d5f4d9b 100644 --- a/doc/en/snippets/BoundsWithNone.rst +++ b/doc/en/snippets/BoundsWithNone.rst @@ -7,5 +7,5 @@ Bounds there is no bound. The bounds can always be specified, but they are taken into account only by the constrained optimizers. - Example : + Example: ``{"Bounds":[[2.,5.],[1.e-2,10.],[-30.,None],[None,None]]}`` diff --git a/doc/en/snippets/ConstrainedBy.rst b/doc/en/snippets/ConstrainedBy.rst index e422edc..67a123e 100644 --- a/doc/en/snippets/ConstrainedBy.rst +++ b/doc/en/snippets/ConstrainedBy.rst @@ -5,5 +5,5 @@ ConstrainedBy constraints. The only one available is the "EstimateProjection", which projects the current state estimate on the bounds constraints. - Example : + Example: ``{"ConstrainedBy":"EstimateProjection"}`` diff --git a/doc/en/snippets/CostDecrementTolerance.rst b/doc/en/snippets/CostDecrementTolerance.rst index e3846ef..588ec84 100644 --- a/doc/en/snippets/CostDecrementTolerance.rst +++ b/doc/en/snippets/CostDecrementTolerance.rst @@ -6,5 +6,5 @@ CostDecrementTolerance this tolerance at the last step. The default is 1.e-7, and it is recommended to adapt it to the needs on real problems. - Example : + Example: ``{"CostDecrementTolerance":1.e-7}`` diff --git a/doc/en/snippets/CostDecrementTolerance_6.rst b/doc/en/snippets/CostDecrementTolerance_6.rst index 80db1b0..a62f212 100644 --- a/doc/en/snippets/CostDecrementTolerance_6.rst +++ b/doc/en/snippets/CostDecrementTolerance_6.rst @@ -6,4 +6,5 @@ CostDecrementTolerance this tolerance at the last step. The default is 1.e-6, and it is recommended to adapt it to the needs on real problems. - Example : ``{"CostDecrementTolerance":1.e-6}`` + Example: + ``{"CostDecrementTolerance":1.e-6}`` diff --git a/doc/en/snippets/CostFunctionJ.rst b/doc/en/snippets/CostFunctionJ.rst index 17e479c..abaee4f 100644 --- a/doc/en/snippets/CostFunctionJ.rst +++ b/doc/en/snippets/CostFunctionJ.rst @@ -4,5 +4,5 @@ CostFunctionJ *List of values*. Each element is a value of the chosen error function :math:`J`. - Example : + Example: ``J = ADD.get("CostFunctionJ")[:]`` diff --git a/doc/en/snippets/CostFunctionJAtCurrentOptimum.rst b/doc/en/snippets/CostFunctionJAtCurrentOptimum.rst index 62b01c0..2337594 100644 --- a/doc/en/snippets/CostFunctionJAtCurrentOptimum.rst +++ b/doc/en/snippets/CostFunctionJAtCurrentOptimum.rst @@ -5,5 +5,5 @@ CostFunctionJAtCurrentOptimum At each step, the value corresponds to the optimal state found from the beginning. - Example : + Example: ``JACO = ADD.get("CostFunctionJAtCurrentOptimum")[:]`` diff --git a/doc/en/snippets/CostFunctionJb.rst b/doc/en/snippets/CostFunctionJb.rst index 14c586a..7741860 100644 --- a/doc/en/snippets/CostFunctionJb.rst +++ b/doc/en/snippets/CostFunctionJb.rst @@ -5,5 +5,5 @@ CostFunctionJb that is of the background difference part. If this part does not exist in the error function, its value is zero. - Example : + Example: ``Jb = ADD.get("CostFunctionJb")[:]`` diff --git a/doc/en/snippets/CostFunctionJbAtCurrentOptimum.rst b/doc/en/snippets/CostFunctionJbAtCurrentOptimum.rst index 5dd8e5a..c179346 100644 --- a/doc/en/snippets/CostFunctionJbAtCurrentOptimum.rst +++ b/doc/en/snippets/CostFunctionJbAtCurrentOptimum.rst @@ -6,5 +6,5 @@ CostFunctionJbAtCurrentOptimum beginning. If this part does not exist in the error function, its value is zero. - Example : + Example: ``JbACO = ADD.get("CostFunctionJbAtCurrentOptimum")[:]`` diff --git a/doc/en/snippets/CostFunctionJo.rst b/doc/en/snippets/CostFunctionJo.rst index f18e35a..2e91e14 100644 --- a/doc/en/snippets/CostFunctionJo.rst +++ b/doc/en/snippets/CostFunctionJo.rst @@ -4,5 +4,5 @@ CostFunctionJo *List of values*. Each element is a value of the error function :math:`J^o`, that is of the observation difference part. - Example : + Example: ``Jo = ADD.get("CostFunctionJo")[:]`` diff --git a/doc/en/snippets/CostFunctionJoAtCurrentOptimum.rst b/doc/en/snippets/CostFunctionJoAtCurrentOptimum.rst index 27cd6e4..f60cef7 100644 --- a/doc/en/snippets/CostFunctionJoAtCurrentOptimum.rst +++ b/doc/en/snippets/CostFunctionJoAtCurrentOptimum.rst @@ -5,5 +5,5 @@ CostFunctionJoAtCurrentOptimum that is of the observation difference part. At each step, the value corresponds to the optimal state found from the beginning. - Example : + Example: ``JoACO = ADD.get("CostFunctionJoAtCurrentOptimum")[:]`` diff --git a/doc/en/snippets/CurrentOptimum.rst b/doc/en/snippets/CurrentOptimum.rst index 7e92f52..15ed061 100644 --- a/doc/en/snippets/CurrentOptimum.rst +++ b/doc/en/snippets/CurrentOptimum.rst @@ -4,5 +4,5 @@ CurrentOptimum *List of vectors*. Each element is the optimal state obtained at the current step of the optimization algorithm. It is not necessarily the last state. - Example : + Example: ``Xo = ADD.get("CurrentOptimum")[:]`` diff --git a/doc/en/snippets/CurrentState.rst b/doc/en/snippets/CurrentState.rst index 37720a4..ae59499 100644 --- a/doc/en/snippets/CurrentState.rst +++ b/doc/en/snippets/CurrentState.rst @@ -4,5 +4,5 @@ CurrentState *List of vectors*. Each element is a usual state vector used during the iterative algorithm procedure. - Example : + Example: ``Xs = ADD.get("CurrentState")[:]`` diff --git a/doc/en/snippets/EpsilonMinimumExponent.rst b/doc/en/snippets/EpsilonMinimumExponent.rst index bbe3158..70ca756 100644 --- a/doc/en/snippets/EpsilonMinimumExponent.rst +++ b/doc/en/snippets/EpsilonMinimumExponent.rst @@ -7,5 +7,5 @@ EpsilonMinimumExponent calculate the residue of the scalar product formula with a fixed increment multiplied from 1.e0 to 1.e-8. - Example : + Example: ``{"EpsilonMinimumExponent":-12}`` diff --git a/doc/en/snippets/EstimationOf.rst b/doc/en/snippets/EstimationOf.rst index a999b54..c5d0d2f 100644 --- a/doc/en/snippets/EstimationOf.rst +++ b/doc/en/snippets/EstimationOf.rst @@ -5,5 +5,5 @@ EstimationOf either state-estimation, with a value of "State", or parameter-estimation, with a value of "Parameters". The default choice is "State". - Example : + Example: ``{"EstimationOf":"Parameters"}`` diff --git a/doc/en/snippets/GradientNormTolerance.rst b/doc/en/snippets/GradientNormTolerance.rst index e77c7ee..80891c5 100644 --- a/doc/en/snippets/GradientNormTolerance.rst +++ b/doc/en/snippets/GradientNormTolerance.rst @@ -6,5 +6,5 @@ GradientNormTolerance limit. It is only used for non-constrained optimizers. The default is 1.e-5 and it is not recommended to change it. - Example : + Example: ``{"GradientNormTolerance":1.e-5}`` diff --git a/doc/en/snippets/IndexOfOptimum.rst b/doc/en/snippets/IndexOfOptimum.rst index 785b173..a330d2c 100644 --- a/doc/en/snippets/IndexOfOptimum.rst +++ b/doc/en/snippets/IndexOfOptimum.rst @@ -5,5 +5,5 @@ IndexOfOptimum obtained at the current step the optimization algorithm. It is not necessarily the number of the last iteration. - Example : + Example: ``i = ADD.get("IndexOfOptimum")[-1]`` diff --git a/doc/en/snippets/InitialDirection.rst b/doc/en/snippets/InitialDirection.rst index b1df33d..1b18081 100644 --- a/doc/en/snippets/InitialDirection.rst +++ b/doc/en/snippets/InitialDirection.rst @@ -6,5 +6,5 @@ InitialDirection this direction defaults to a random perturbation around zero of the same vector size than the checking point. - Example : + Example: ``{"InitialDirection":[0.1,0.1,100.,3}`` diff --git a/doc/en/snippets/Innovation.rst b/doc/en/snippets/Innovation.rst index 5a09a99..4d05e77 100644 --- a/doc/en/snippets/Innovation.rst +++ b/doc/en/snippets/Innovation.rst @@ -5,5 +5,5 @@ Innovation the difference between the optimal and the background, and in dynamic the evolution increment. - Example : + Example: ``d = ADD.get("Innovation")[-1]`` diff --git a/doc/en/snippets/InnovationAtCurrentState.rst b/doc/en/snippets/InnovationAtCurrentState.rst index 0ace580..00c82e2 100644 --- a/doc/en/snippets/InnovationAtCurrentState.rst +++ b/doc/en/snippets/InnovationAtCurrentState.rst @@ -3,5 +3,5 @@ InnovationAtCurrentState *List of vectors*. Each element is an innovation vector at current state. - Example : + Example: ``ds = ADD.get("InnovationAtCurrentState")[-1]`` diff --git a/doc/en/snippets/MahalanobisConsistency.rst b/doc/en/snippets/MahalanobisConsistency.rst index 006b920..a01f2a9 100644 --- a/doc/en/snippets/MahalanobisConsistency.rst +++ b/doc/en/snippets/MahalanobisConsistency.rst @@ -4,5 +4,5 @@ MahalanobisConsistency *List of values*. Each element is a value of the Mahalanobis quality indicator. - Example : + Example: ``m = ADD.get("MahalanobisConsistency")[-1]`` diff --git a/doc/en/snippets/MaximumNumberOfFunctionEvaluations.rst b/doc/en/snippets/MaximumNumberOfFunctionEvaluations.rst index fbe814b..e94fdd0 100644 --- a/doc/en/snippets/MaximumNumberOfFunctionEvaluations.rst +++ b/doc/en/snippets/MaximumNumberOfFunctionEvaluations.rst @@ -7,5 +7,5 @@ MaximumNumberOfFunctionEvaluations optimizers, the effective number of function evaluations can be slightly different of the limit due to algorithm internal control requirements. - Example : + Example: ``{"MaximumNumberOfFunctionEvaluations":50}`` diff --git a/doc/en/snippets/MaximumNumberOfSteps.rst b/doc/en/snippets/MaximumNumberOfSteps.rst index 1f67c8a..5272280 100644 --- a/doc/en/snippets/MaximumNumberOfSteps.rst +++ b/doc/en/snippets/MaximumNumberOfSteps.rst @@ -8,5 +8,5 @@ MaximumNumberOfSteps slightly different of the limit due to algorithm internal control requirements. - Example : + Example: ``{"MaximumNumberOfSteps":100}`` diff --git a/doc/en/snippets/MaximumNumberOfSteps_50.rst b/doc/en/snippets/MaximumNumberOfSteps_50.rst index d64ae08..e03f5bf 100644 --- a/doc/en/snippets/MaximumNumberOfSteps_50.rst +++ b/doc/en/snippets/MaximumNumberOfSteps_50.rst @@ -5,5 +5,5 @@ MaximumNumberOfSteps optimization. The default is 50, which is an arbitrary limit. It is then recommended to adapt this parameter to the needs on real problems. - Example : + Example: ``{"MaximumNumberOfSteps":50}`` diff --git a/doc/en/snippets/Minimizer_DFO.rst b/doc/en/snippets/Minimizer_DFO.rst index 9b59de8..c2905ad 100644 --- a/doc/en/snippets/Minimizer_DFO.rst +++ b/doc/en/snippets/Minimizer_DFO.rst @@ -14,5 +14,5 @@ Minimizer it is the outer loop limit than is controlled. If precise control on this cost function evaluation number is required, choose an another minimizer. - Example : + Example: ``{"Minimizer":"BOBYQA"}`` diff --git a/doc/en/snippets/NumberOfMembers.rst b/doc/en/snippets/NumberOfMembers.rst index 429af00..9410366 100644 --- a/doc/en/snippets/NumberOfMembers.rst +++ b/doc/en/snippets/NumberOfMembers.rst @@ -5,5 +5,5 @@ NumberOfMembers The default is 100, and it is recommended to adapt it to the needs on real problems. - Example : + Example: ``{"NumberOfMembers":100}`` diff --git a/doc/en/snippets/NumberOfPrintedDigits.rst b/doc/en/snippets/NumberOfPrintedDigits.rst index deb9077..b8dcfc9 100644 --- a/doc/en/snippets/NumberOfPrintedDigits.rst +++ b/doc/en/snippets/NumberOfPrintedDigits.rst @@ -4,5 +4,5 @@ NumberOfPrintedDigits This key indicates the number of digits of precision for floating point printed output. The default is 5, with a minimum of 0. - Example : + Example: ``{"NumberOfPrintedDigits":5}`` diff --git a/doc/en/snippets/NumberOfRepetition.rst b/doc/en/snippets/NumberOfRepetition.rst index 55a05e7..ca6f489 100644 --- a/doc/en/snippets/NumberOfRepetition.rst +++ b/doc/en/snippets/NumberOfRepetition.rst @@ -4,5 +4,5 @@ NumberOfRepetition This key indicates the number of time to repeat the function evaluation. The default is 1. - Example : + Example: ``{"NumberOfRepetition":3}`` diff --git a/doc/en/snippets/NumberOfSamplesForQuantiles.rst b/doc/en/snippets/NumberOfSamplesForQuantiles.rst index a125f64..3568cce 100644 --- a/doc/en/snippets/NumberOfSamplesForQuantiles.rst +++ b/doc/en/snippets/NumberOfSamplesForQuantiles.rst @@ -7,5 +7,5 @@ NumberOfSamplesForQuantiles sufficient for correct estimation of common quantiles at 5%, 10%, 90% or 95%. - Example : + Example: ``{"NumberOfSamplesForQuantiles":100}`` diff --git a/doc/en/snippets/OMA.rst b/doc/en/snippets/OMA.rst index fa3713a..46091f4 100644 --- a/doc/en/snippets/OMA.rst +++ b/doc/en/snippets/OMA.rst @@ -4,5 +4,5 @@ OMA *List of vectors*. Each element is a vector of difference between the observation and the optimal state in the observation space. - Example : + Example: ``oma = ADD.get("OMA")[-1]`` diff --git a/doc/en/snippets/OMB.rst b/doc/en/snippets/OMB.rst index 163946b..3629904 100644 --- a/doc/en/snippets/OMB.rst +++ b/doc/en/snippets/OMB.rst @@ -4,5 +4,5 @@ OMB *List of vectors*. Each element is a vector of difference between the observation and the background state in the observation space. - Example : + Example: ``omb = ADD.get("OMB")[-1]`` diff --git a/doc/en/snippets/ProjectedGradientTolerance.rst b/doc/en/snippets/ProjectedGradientTolerance.rst index 4f078ea..2939c85 100644 --- a/doc/en/snippets/ProjectedGradientTolerance.rst +++ b/doc/en/snippets/ProjectedGradientTolerance.rst @@ -7,5 +7,5 @@ ProjectedGradientTolerance -1, that is the internal default of each minimizer (generally 1.e-5), and it is not recommended to change it. - Example : + Example: ``{"ProjectedGradientTolerance":-1}`` diff --git a/doc/en/snippets/QualityCriterion.rst b/doc/en/snippets/QualityCriterion.rst index 2d5261a..9147b6e 100644 --- a/doc/en/snippets/QualityCriterion.rst +++ b/doc/en/snippets/QualityCriterion.rst @@ -9,5 +9,5 @@ QualityCriterion "WeightedLeastSquares"<=>"WLS", "LeastSquares"<=>"LS"<=>"L2", "AbsoluteValue"<=>"L1", "MaximumError"<=>"ME"]. - Example : + Example: ``{"QualityCriterion":"DA"}`` diff --git a/doc/en/snippets/Quantile.rst b/doc/en/snippets/Quantile.rst index 574c754..ce9b377 100644 --- a/doc/en/snippets/Quantile.rst +++ b/doc/en/snippets/Quantile.rst @@ -4,5 +4,5 @@ Quantile This key allows to define the real value of the desired quantile, between 0 and 1. The default is 0.5, corresponding to the median. - Example : + Example: ``{"Quantile":0.5}`` diff --git a/doc/en/snippets/Quantiles.rst b/doc/en/snippets/Quantiles.rst index f9c41c7..beb99ac 100644 --- a/doc/en/snippets/Quantiles.rst +++ b/doc/en/snippets/Quantiles.rst @@ -7,5 +7,5 @@ Quantiles This option is useful only if the supplementary calculation "SimulationQuantiles" has been chosen. The default is a void list. - Example : + Example: ``{"Quantiles":[0.1,0.9]}`` diff --git a/doc/en/snippets/Residu.rst b/doc/en/snippets/Residu.rst index feb8cd7..7c875d8 100644 --- a/doc/en/snippets/Residu.rst +++ b/doc/en/snippets/Residu.rst @@ -4,5 +4,5 @@ Residu *List of values*. Each element is the value of the particular residue verified during a checking algorithm, in the order of the tests. - Example : + Example: ``r = ADD.get("Residu")[:]`` diff --git a/doc/en/snippets/SetDebug.rst b/doc/en/snippets/SetDebug.rst index 36fd5a7..66d8b07 100644 --- a/doc/en/snippets/SetDebug.rst +++ b/doc/en/snippets/SetDebug.rst @@ -5,5 +5,5 @@ SetDebug function or operator evaluation. The default is "False", the choices are "True" or "False". - Example : + Example: ``{"SetDebug":False}`` diff --git a/doc/en/snippets/SetSeed.rst b/doc/en/snippets/SetSeed.rst index 16258cb..e4fd764 100644 --- a/doc/en/snippets/SetSeed.rst +++ b/doc/en/snippets/SetSeed.rst @@ -8,5 +8,5 @@ SetSeed the reproducibility of results involving random samples, it is strongly advised to initialize the seed. - Example : + Example: ``{"SetSeed":1000}`` diff --git a/doc/en/snippets/SigmaBck2.rst b/doc/en/snippets/SigmaBck2.rst index fce70d9..cb0626f 100644 --- a/doc/en/snippets/SigmaBck2.rst +++ b/doc/en/snippets/SigmaBck2.rst @@ -4,5 +4,5 @@ SigmaBck2 *List of values*. Each element is a value of the quality indicator :math:`(\sigma^b)^2` of the background part. - Example : + Example: ``sb2 = ADD.get("SigmaBck")[-1]`` diff --git a/doc/en/snippets/SigmaObs2.rst b/doc/en/snippets/SigmaObs2.rst index f05499f..da88ad8 100644 --- a/doc/en/snippets/SigmaObs2.rst +++ b/doc/en/snippets/SigmaObs2.rst @@ -4,5 +4,5 @@ SigmaObs2 *List of values*. Each element is a value of the quality indicator :math:`(\sigma^o)^2` of the observation part. - Example : + Example: ``so2 = ADD.get("SigmaObs")[-1]`` diff --git a/doc/en/snippets/SimulatedObservationAtBackground.rst b/doc/en/snippets/SimulatedObservationAtBackground.rst index 7cbb7bc..79ea1d4 100644 --- a/doc/en/snippets/SimulatedObservationAtBackground.rst +++ b/doc/en/snippets/SimulatedObservationAtBackground.rst @@ -6,5 +6,5 @@ SimulatedObservationAtBackground observation operator from the background :math:`\mathbf{x}^b`. It is the forecast from the background, and it is sometimes called "*Dry*". - Example : + Example: ``hxb = ADD.get("SimulatedObservationAtBackground")[-1]`` diff --git a/doc/en/snippets/SimulatedObservationAtCurrentOptimum.rst b/doc/en/snippets/SimulatedObservationAtCurrentOptimum.rst index 1e4d5a7..0459fd1 100644 --- a/doc/en/snippets/SimulatedObservationAtCurrentOptimum.rst +++ b/doc/en/snippets/SimulatedObservationAtCurrentOptimum.rst @@ -5,5 +5,5 @@ SimulatedObservationAtCurrentOptimum the optimal state obtained at the current step the optimization algorithm, that is, in the observation space. - Example : + Example: ``hxo = ADD.get("SimulatedObservationAtCurrentOptimum")[-1]`` diff --git a/doc/en/snippets/SimulatedObservationAtCurrentState.rst b/doc/en/snippets/SimulatedObservationAtCurrentState.rst index e0616fc..e4d704d 100644 --- a/doc/en/snippets/SimulatedObservationAtCurrentState.rst +++ b/doc/en/snippets/SimulatedObservationAtCurrentState.rst @@ -5,5 +5,5 @@ SimulatedObservationAtCurrentState observation operator from the current state, that is, in the observation space. - Example : + Example: ``hxs = ADD.get("SimulatedObservationAtCurrentState")[-1]`` diff --git a/doc/en/snippets/SimulatedObservationAtOptimum.rst b/doc/en/snippets/SimulatedObservationAtOptimum.rst index c10f5da..a3bc4cc 100644 --- a/doc/en/snippets/SimulatedObservationAtOptimum.rst +++ b/doc/en/snippets/SimulatedObservationAtOptimum.rst @@ -7,5 +7,5 @@ SimulatedObservationAtOptimum It is the forecast from the analysis or the optimal state, and it is sometimes called "*Forecast*". - Example : + Example: ``hxa = ADD.get("SimulatedObservationAtOptimum")[-1]`` diff --git a/doc/en/snippets/SimulationForQuantiles.rst b/doc/en/snippets/SimulationForQuantiles.rst index e446a4c..68f576c 100644 --- a/doc/en/snippets/SimulationForQuantiles.rst +++ b/doc/en/snippets/SimulationForQuantiles.rst @@ -10,5 +10,5 @@ SimulationForQuantiles "SimulationQuantiles" has been chosen. The default value is "Linear", and the possible choices are "Linear" and "NonLinear". - Example : + Example: ``{"SimulationForQuantiles":"Linear"}`` diff --git a/doc/en/snippets/SimulationQuantiles.rst b/doc/en/snippets/SimulationQuantiles.rst index 188a641..da7132d 100644 --- a/doc/en/snippets/SimulationQuantiles.rst +++ b/doc/en/snippets/SimulationQuantiles.rst @@ -5,5 +5,5 @@ SimulationQuantiles state which realize the required quantile, in the same order than the quantiles values required by the user. - Example : + Example: ``sQuantiles = ADD.get("SimulationQuantiles")[:]`` diff --git a/doc/en/snippets/StateVariationTolerance.rst b/doc/en/snippets/StateVariationTolerance.rst index 9e2d774..07309ad 100644 --- a/doc/en/snippets/StateVariationTolerance.rst +++ b/doc/en/snippets/StateVariationTolerance.rst @@ -5,5 +5,5 @@ StateVariationTolerance by convergence on the state. The default is 1.e-4, and it is recommended to adapt it to the needs on real problems. - Example : + Example: ``{"StateVariationTolerance":1.e-4}`` -- 2.39.2