From: Jean-Philippe ARGAUD Date: Sun, 16 Jun 2019 10:02:39 +0000 (+0200) Subject: Updating and correcting documentation X-Git-Tag: V9_4_0b1~13 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=f8d722a7af099661a82b4d8834622c6989897f80;p=modules%2Fadao.git Updating and correcting documentation --- diff --git a/doc/en/advanced.rst b/doc/en/advanced.rst index cbc9cd3..5dc694d 100644 --- a/doc/en/advanced.rst +++ b/doc/en/advanced.rst @@ -501,7 +501,7 @@ with a new name. To make future developments easier, it is strongly recommended to ensure that your user scripts files use a Python 2 and a Python 3 compatible syntax. In particular, it is recommended to use the functional syntax for "*print*" and not -the "*command*" syntax, for example: +the "*command*" syntax, for example:: # Python 2 & 3 x, unit = 1., "cm" diff --git a/doc/en/glossary.rst b/doc/en/glossary.rst index 61ee03a..a3a33b2 100644 --- a/doc/en/glossary.rst +++ b/doc/en/glossary.rst @@ -94,20 +94,25 @@ Glossary Keyword to indicate the standard errors diagonal matrix of *a posteriori* analysis errors. - BMA (Background minus Analysis) - Difference between the background state and the optimal state estimation, - noted as :math:`\mathbf{x}^b - \mathbf{x}^a`. - - OMA (Observation minus Analysis) - Difference between the observations and the result of the simulation based - on the optimal state estimation, the analysis, filtered to be compatible - with the observation, noted as :math:`\mathbf{y}^o - - \mathbf{H}\mathbf{x}^a`. - - OMB (Observation minus Background) - Difference between the observations and the result of the simulation based - on the background state, filtered to be compatible with the observation, - noted as :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^b`. + BMA + The acronym means *Background minus Analysis*. It is the difference + between the background state and the optimal state estimation, + corresponding to the mathematical expression :math:`\mathbf{x}^b - + \mathbf{x}^a`. + + OMA + The acronym means *Observation minus Analysis*. It is the difference + between the observations and the result of the simulation based on the + optimal state estimation, the analysis, filtered to be compatible with + the observation, corresponding to the mathematical expression + :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^a`. + + OMB + The acronym means *Observation minus Background*. It is the difference + between the observations and the result of the simulation based on the + background state, filtered to be compatible with the observation, + corresponding to the mathematical expression :math:`\mathbf{y}^o - + \mathbf{H}\mathbf{x}^b`. SigmaBck2 Keyword to indicate the Desroziers-Ivanov parameter measuring the diff --git a/doc/en/ref_algorithm_FunctionTest.rst b/doc/en/ref_algorithm_FunctionTest.rst index 2542a08..9f38afc 100644 --- a/doc/en/ref_algorithm_FunctionTest.rst +++ b/doc/en/ref_algorithm_FunctionTest.rst @@ -88,3 +88,4 @@ StoreSupplementaryCalculations .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_LinearityTest` +- :ref:`section_ref_algorithm_ParallelFunctionTest` diff --git a/doc/en/ref_algorithm_ParallelFunctionTest.rst b/doc/en/ref_algorithm_ParallelFunctionTest.rst new file mode 100644 index 0000000..58d6ba4 --- /dev/null +++ b/doc/en/ref_algorithm_ParallelFunctionTest.rst @@ -0,0 +1,91 @@ +.. + Copyright (C) 2008-2019 EDF R&D + + This file is part of SALOME ADAO module. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com + + Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D + +.. index:: single: ParallelFunctionTest +.. _section_ref_algorithm_ParallelFunctionTest: + +Checking algorithm "*ParallelFunctionTest*" +------------------------------------------- + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo01.rst + +This algorithm allows to verify that the observation operator is working +correctly in parallel and that its call is compatible with its usage in ADAO +algorithms. In practice, it allows to call one or several times the operator in +parallel, activating or not the "debug" mode during execution. + +Statistics on input and output vectors for each execution of operator are given, +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. + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo02.rst + +.. include:: snippets/CheckingPoint.rst + +.. include:: snippets/ObservationOperator.rst + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo03Chck.rst + +.. include:: snippets/NumberOfPrintedDigits.rst + +.. include:: snippets/NumberOfRepetition.rst + +.. include:: snippets/SetDebug.rst + +StoreSupplementaryCalculations + .. index:: single: StoreSupplementaryCalculations + + This list indicates the names of the supplementary variables that can be + available at the end of the algorithm, if they are initially required by the + user. It involves potentially costly calculations or memory consumptions. The + default is a void list, none of these variables being calculated and stored + by default excepted the unconditionnal variables. The possible names are in + the following list: [ + "CurrentState", + "SimulatedObservationAtCurrentState", + ]. + + Example : + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo04.rst + +*None* + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo05.rst + +.. include:: snippets/CurrentState.rst + +.. include:: snippets/SimulatedObservationAtCurrentState.rst + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo06.rst + +- :ref:`section_ref_algorithm_FunctionTest` +- :ref:`section_ref_algorithm_LinearityTest` diff --git a/doc/en/reference.rst b/doc/en/reference.rst index 5f2664a..624bc1a 100644 --- a/doc/en/reference.rst +++ b/doc/en/reference.rst @@ -137,6 +137,7 @@ The mathematical notations used afterward are explained in the section ref_algorithm_LinearityTest ref_algorithm_LocalSensitivityTest ref_algorithm_ObserverTest + ref_algorithm_ParallelFunctionTest ref_algorithm_SamplingTest ref_algorithm_TangentTest ref_checking_keywords diff --git a/doc/fr/glossary.rst b/doc/fr/glossary.rst index fcecff8..1ab15d2 100644 --- a/doc/fr/glossary.rst +++ b/doc/fr/glossary.rst @@ -98,19 +98,24 @@ Glossaire Mot-clé indiquant la matrice diagonale des écarts-types des erreurs *a posteriori* d'analyse. - BMA (Background minus Analysis) - Différence entre l'état d'ébauche et l'état optimal estimé, notée - :math:`\mathbf{x}^b - \mathbf{x}^a`. - - OMA (Observation minus Analysis) - Différence entre les observations et le résultat de la simulation basée - sur l'état optimal estimé, l'analyse, filtré pour être compatible avec les - observations, notée :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^a`. - - OMB (Observation minus Background) - Différence entre les observations et le résultat de la simulation basée - sur l'état d'ébauche, filtré pour être compatible avec les observations, - notée :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^b`. + BMA + L'acronyme signifie *Background moins Analysis*. C'est la différence + entre l'état d'ébauche et l'état optimal estimé, correspondant à + l'expression mathématique :math:`\mathbf{x}^b - \mathbf{x}^a`. + + OMA + L'acronyme signifie *Observation moins Analysis*. C'est la différence + entre les observations et le résultat de la simulation basée sur l'état + optimal estimé, l'analyse, filtré pour être compatible avec les + observations, correspondant à l'expression mathématique + :math:`\mathbf{y}^o - \mathbf{H}\mathbf{x}^a`. + + OMB + L'acronyme signifie *Observation moins Background*. C'est la différence + entre les observations et le résultat de la simulation basée sur l'état + d'ébauche, filtré pour être compatible avec les observations, + correspondant à l'expression mathématique :math:`\mathbf{y}^o - + \mathbf{H}\mathbf{x}^b`. SigmaBck2 Mot-clé indiquant le paramètre de Desroziers-Ivanov mesurant la diff --git a/doc/fr/ref_algorithm_FunctionTest.rst b/doc/fr/ref_algorithm_FunctionTest.rst index f122a5a..da54fed 100644 --- a/doc/fr/ref_algorithm_FunctionTest.rst +++ b/doc/fr/ref_algorithm_FunctionTest.rst @@ -90,3 +90,4 @@ StoreSupplementaryCalculations .. include:: snippets/Header2Algo06.rst - :ref:`section_ref_algorithm_LinearityTest` +- :ref:`section_ref_algorithm_ParallelFunctionTest` diff --git a/doc/fr/ref_algorithm_ParallelFunctionTest.rst b/doc/fr/ref_algorithm_ParallelFunctionTest.rst new file mode 100644 index 0000000..7e9b1d5 --- /dev/null +++ b/doc/fr/ref_algorithm_ParallelFunctionTest.rst @@ -0,0 +1,93 @@ +.. + Copyright (C) 2008-2019 EDF R&D + + This file is part of SALOME ADAO module. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com + + Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D + +.. index:: single: ParallelFunctionTest +.. _section_ref_algorithm_ParallelFunctionTest: + +Algorithme de vérification "*ParallelFunctionTest*" +--------------------------------------------------- + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo01.rst + +Cet algorithme permet de vérifier que l'opérateur d'observation fonctionne +correctement en parallèle et que son appel se déroule de manière compatible +avec son usage dans les algorithmes d'ADAO. De manière pratique, il permet +d'appeler une ou plusieurs fois l'opérateur en parallèle, en activant ou non le +mode "debug" lors de l'exécution. + +Une statistique sur les vecteurs en entrée et en sortie de chaque exécution de +l'opérateur est indiquée, et une autre globale est fournie de manière +récapitulative à la fin de l'algorithme de vérification. La précision +d'affichage est contrôlable pour permettre l'automatisation des tests +d'opérateur. + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo02.rst + +.. include:: snippets/CheckingPoint.rst + +.. include:: snippets/ObservationOperator.rst + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo03Chck.rst + +.. include:: snippets/NumberOfPrintedDigits.rst + +.. include:: snippets/NumberOfRepetition.rst + +.. include:: snippets/SetDebug.rst + +StoreSupplementaryCalculations + .. index:: single: StoreSupplementaryCalculations + + Cette liste indique les noms des variables supplémentaires qui peuvent être + disponibles à la fin de l'algorithme, si elles sont initialement demandées par + l'utilisateur. Cela implique potentiellement des calculs ou du stockage + coûteux. La valeur par défaut est une liste vide, aucune de ces variables + n'étant calculée et stockée par défaut sauf les variables inconditionnelles. + Les noms possibles sont dans la liste suivante : [ + "CurrentState", + "SimulatedObservationAtCurrentState", + ]. + + Exemple : + ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}`` + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo04.rst + +*Aucune* + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo05.rst + +.. include:: snippets/CurrentState.rst + +.. include:: snippets/SimulatedObservationAtCurrentState.rst + +.. ------------------------------------ .. +.. include:: snippets/Header2Algo06.rst + +- :ref:`section_ref_algorithm_FunctionTest` +- :ref:`section_ref_algorithm_LinearityTest` diff --git a/doc/fr/reference.rst b/doc/fr/reference.rst index 9e1373c..0bc508e 100644 --- a/doc/fr/reference.rst +++ b/doc/fr/reference.rst @@ -138,6 +138,7 @@ section :ref:`section_theory`. ref_algorithm_LinearityTest ref_algorithm_LocalSensitivityTest ref_algorithm_ObserverTest + ref_algorithm_ParallelFunctionTest ref_algorithm_SamplingTest ref_algorithm_TangentTest ref_checking_keywords