From b2626916786bab4f58b5332e7fbbd71e7bccd23b Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Sat, 9 Mar 2019 18:39:33 +0100 Subject: [PATCH] Updating documentation by review and snippets (9): EN part --- doc/en/ref_algorithm_FunctionTest.rst | 79 ++++++--------- doc/en/ref_algorithm_LinearLeastSquares.rst | 106 +++++++++----------- 2 files changed, 79 insertions(+), 106 deletions(-) diff --git a/doc/en/ref_algorithm_FunctionTest.rst b/doc/en/ref_algorithm_FunctionTest.rst index 0424e7c..1d83930 100644 --- a/doc/en/ref_algorithm_FunctionTest.rst +++ b/doc/en/ref_algorithm_FunctionTest.rst @@ -27,8 +27,8 @@ Checking algorithm "*FunctionTest*" ----------------------------------- -Description -+++++++++++ +.. ------------------------------------ .. +.. include:: snippets/Header2Algo01.rst This algorithm allows to verify that the observation operator is working correctly and that its call is compatible with its usage in ADAO algorithms. In @@ -40,63 +40,50 @@ and an another global statistic is given at the end of the checking algorithm. The precision of printed outputs can be controlled to facilitate automatic tests of operator. -Optional and required commands -++++++++++++++++++++++++++++++ +.. ------------------------------------ .. +.. include:: snippets/Header2Algo02.rst -The general required commands, available in the editing user interface, are the -following: +.. include:: snippets/CheckingPoint.rst - .. include:: snippets/CheckingPoint.rst +.. include:: snippets/ObservationOperator.rst - .. include:: snippets/ObservationOperator.rst +.. ------------------------------------ .. +.. include:: snippets/Header2Algo03Chck.rst -The general optional commands, available in the editing user interface, are -indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters -of the command "*AlgorithmParameters*" allow to choose the specific options, -described hereafter, of the algorithm. See -:ref:`section_ref_options_Algorithm_Parameters` for the good use of this -command. +.. include:: snippets/NumberOfPrintedDigits.rst -The options of the algorithm are the following: +.. include:: snippets/NumberOfRepetition.rst - .. include:: snippets/NumberOfPrintedDigits.rst +.. include:: snippets/SetDebug.rst - .. include:: snippets/NumberOfRepetition.rst +StoreSupplementaryCalculations + .. index:: single: StoreSupplementaryCalculations - .. include:: snippets/SetDebug.rst + This list indicates the names of the supplementary variables that can be + available at the end of the algorithm. It involves potentially costly + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: [ + "CurrentState", + "SimulatedObservationAtCurrentState", + ]. - StoreSupplementaryCalculations - .. index:: single: StoreSupplementaryCalculations + Example : + ``{"StoreSupplementaryCalculations":["CurrentState"]}`` - This list indicates the names of the supplementary variables that can be - available at the end of the algorithm. It involves potentially costly - calculations or memory consumptions. The default is a void list, none of - these variables being calculated and stored by default. The possible names - are in the following list: ["CurrentState", - "SimulatedObservationAtCurrentState"]. +.. ------------------------------------ .. +.. include:: snippets/Header2Algo04.rst - Example : - ``{"StoreSupplementaryCalculations":["CurrentState"]}`` +*None* -Information and variables available at the end of the algorithm -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +.. ------------------------------------ .. +.. include:: snippets/Header2Algo05.rst -At the output, after executing the algorithm, there are variables and -information originating from the calculation. The description of -:ref:`section_ref_output_variables` show the way to obtain them by the method -named ``get`` of the variable "*ADD*" of the post-processing. The input -variables, available to the user at the output in order to facilitate the -writing of post-processing procedures, are described in the -:ref:`subsection_r_o_v_Inventaire`. +.. include:: snippets/CurrentState.rst -The conditional outputs of the algorithm are the following: +.. include:: snippets/SimulatedObservationAtCurrentState.rst - .. include:: snippets/CurrentState.rst +.. ------------------------------------ .. +.. include:: snippets/Header2Algo06.rst - .. include:: snippets/SimulatedObservationAtCurrentState.rst - -See also -++++++++ - -References to other sections: - - :ref:`section_ref_algorithm_LinearityTest` +- :ref:`section_ref_algorithm_LinearityTest` diff --git a/doc/en/ref_algorithm_LinearLeastSquares.rst b/doc/en/ref_algorithm_LinearLeastSquares.rst index 72de993..6ddd05c 100644 --- a/doc/en/ref_algorithm_LinearLeastSquares.rst +++ b/doc/en/ref_algorithm_LinearLeastSquares.rst @@ -27,17 +27,17 @@ Calculation algorithm "*LinearLeastSquares*" -------------------------------------------- -Description -+++++++++++ +.. ------------------------------------ .. +.. include:: snippets/Header2Algo01.rst This algorithm realizes a "Least Squares" linear type estimation of the state of a system. It is similar to the :ref:`section_ref_algorithm_Blue`, without its background part. -This algorithm is always the fastest of all the optimization algorithms of ADAO. -It is theoretically reserved for observation operator cases which are linear, -even if it sometimes works in "slightly" non-linear cases. One can verify the -linearity of the observation operator with the help of the +This algorithm is always the fastest of all the optimization algorithms of +ADAO. It is theoretically reserved for observation operator cases which are +explicitly linear, even if it sometimes works in "slightly" non-linear cases. +One can verify the linearity of the observation operator with the help of the :ref:`section_ref_algorithm_LinearityTest`. In all cases, it is recommanded to prefer at least the @@ -45,40 +45,37 @@ In all cases, it is recommanded to prefer at least the :ref:`section_ref_algorithm_ExtendedBlue` or the :ref:`section_ref_algorithm_3DVAR`. -Optional and required commands -++++++++++++++++++++++++++++++ +.. ------------------------------------ .. +.. include:: snippets/Header2Algo02.rst -The general required commands, available in the editing user interface, are the -following: +.. include:: snippets/Observation.rst - .. include:: snippets/Observation.rst +.. include:: snippets/ObservationError.rst - .. include:: snippets/ObservationError.rst +.. include:: snippets/ObservationOperator.rst - .. include:: snippets/ObservationOperator.rst +.. ------------------------------------ .. +.. include:: snippets/Header2Algo03AdOp.rst -The general optional commands, available in the editing user interface, are -indicated in :ref:`section_ref_assimilation_keywords`. Moreover, the parameters -of the command "*AlgorithmParameters*" allows to choose the specific options, -described hereafter, of the algorithm. See -:ref:`section_ref_options_Algorithm_Parameters` for the good use of this -command. +StoreSupplementaryCalculations + .. index:: single: StoreSupplementaryCalculations -The options of the algorithm are the following: + This list indicates the names of the supplementary variables that can be + available at the end of the algorithm. It involves potentially costly + calculations or memory consumptions. The default is a void list, none of + these variables being calculated and stored by default. The possible names + are in the following list: [ + "OMA", + "CurrentState", + "CostFunctionJ", + "CostFunctionJb", + "CostFunctionJo", + "SimulatedObservationAtCurrentState", + "SimulatedObservationAtOptimum", + ]. - StoreSupplementaryCalculations - .. index:: single: StoreSupplementaryCalculations - - This list indicates the names of the supplementary variables that can be - available at the end of the algorithm. It involves potentially costly - calculations or memory consumptions. The default is a void list, none of - these variables being calculated and stored by default. The possible names - are in the following list: ["OMA", "CurrentState", "CostFunctionJ", - "CostFunctionJb", "CostFunctionJo", "SimulatedObservationAtCurrentState", - "SimulatedObservationAtOptimum"]. - - Example : - ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}`` + Example : + ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}`` *Tips for this algorithm:* @@ -87,39 +84,28 @@ The options of the algorithm are the following: even if these commands are not required for this algorithm, and will not be used. The simplest way is to give "1" as a STRING for both. -Information and variables available at the end of the algorithm -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -At the output, after executing the algorithm, there are variables and -information originating from the calculation. The description of -:ref:`section_ref_output_variables` show the way to obtain them by the method -named ``get`` of the variable "*ADD*" of the post-processing. The input -variables, available to the user at the output in order to facilitate the -writing of post-processing procedures, are described in the -:ref:`subsection_r_o_v_Inventaire`. - -The unconditional outputs of the algorithm are the following: - - .. include:: snippets/Analysis.rst +.. ------------------------------------ .. +.. include:: snippets/Header2Algo04.rst - .. include:: snippets/CostFunctionJ.rst +.. include:: snippets/Analysis.rst - .. include:: snippets/CostFunctionJb.rst +.. include:: snippets/CostFunctionJ.rst - .. include:: snippets/CostFunctionJo.rst +.. include:: snippets/CostFunctionJb.rst -The conditional outputs of the algorithm are the following: +.. include:: snippets/CostFunctionJo.rst - .. include:: snippets/OMA.rst +.. ------------------------------------ .. +.. include:: snippets/Header2Algo05.rst - .. include:: snippets/SimulatedObservationAtOptimum.rst +.. include:: snippets/OMA.rst +.. include:: snippets/SimulatedObservationAtOptimum.rst -See also -++++++++ +.. ------------------------------------ .. +.. include:: snippets/Header2Algo06.rst -References to other sections: - - :ref:`section_ref_algorithm_Blue` - - :ref:`section_ref_algorithm_ExtendedBlue` - - :ref:`section_ref_algorithm_3DVAR` - - :ref:`section_ref_algorithm_LinearityTest` +- :ref:`section_ref_algorithm_Blue` +- :ref:`section_ref_algorithm_ExtendedBlue` +- :ref:`section_ref_algorithm_3DVAR` +- :ref:`section_ref_algorithm_LinearityTest` -- 2.39.2