]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation improvements
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 8 Mar 2021 19:24:16 +0000 (20:24 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 8 Mar 2021 19:24:16 +0000 (20:24 +0100)
13 files changed:
doc/en/index.rst
doc/en/intro.rst
doc/en/ref_algorithm_EnsembleKalmanFilter.rst
doc/en/ref_checking_keywords.rst
doc/en/reference.rst
doc/en/scripts/simple_KalmanFilter2.py
doc/fr/index.rst
doc/fr/intro.rst
doc/fr/ref_algorithm_EnsembleKalmanFilter.rst
doc/fr/ref_checking_keywords.rst
doc/fr/reference.rst
doc/fr/scripts/simple_KalmanFilter1.rst
doc/fr/scripts/simple_KalmanFilter2.py

index 751e888595d042088d5fd42052c67cdd24bab347..8d56ac38a38c3c41810f4184012db7513e9bc8e7 100644 (file)
@@ -40,8 +40,10 @@ over time. It uses information coming from experimental measurements or
 observations, and from numerical *a priori* models, including information about
 their errors. Parts of the framework are also known under the names of
 *parameter estimation*, *inverse problems*, *Bayesian estimation*, *optimal
-interpolation*, *field reconstruction*, etc. More details can be found in the
-section :ref:`section_theory`.
+interpolation*, *field reconstruction*, etc. The ADAO module currently offers
+more than 100 different algorithmic methods and allows the study of about 350
+distinct applied problems. More details can be found in the section
+:ref:`section_theory`.
 
 The documentation for this module is divided into several major categories,
 related to the theoretical documentation (indicated in the section title by
@@ -62,7 +64,7 @@ come back regularly to these parts. The following parts describe
 detailed :ref:`section_reference`, with three essential main sub-parts
 describing the details of commands and options of the algorithms. A
 :ref:`section_glossary`, some :ref:`section_notations`, a
-:ref:`section_bibliography` and an extensive :ref:`genindex` are included in
+:ref:`section_bibliography` and an extensive index are included in
 the document. And, to comply with the module requirements, be sure to read the
 part :ref:`section_license`.
 
index 95ff3a9b362c2d8dfdefd679a17f98ec76847949..788ab13f850041b624f71a61a10217c7a3c90a87 100644 (file)
@@ -28,7 +28,7 @@ Introduction to ADAO
 ================================================================================
 
 The aim of the ADAO module is **to help using data assimilation or optimization
-methodology in conjunction with other modules or simulation codes in Python**
+methodology, in conjunction with other modules or simulation codes, in Python**
 [Python]_ **or SALOME context** [Salome]_. The ADAO module provides a simple
 interface to some standard algorithms of data assimilation or optimization, as
 well as test or verification ones. It allows integration of their use in a
@@ -37,17 +37,17 @@ one or more specific calling methods in order to be callable in the Python or
 SALOME framework. All the SALOME modules can be used through Python or YACS
 integration.
 
-Its main objective is **to provide the use of various standard data
-assimilation or optimization methods, while remaining easy to setup, and
-providing a simplified path to help the implementation**. For the end user, who
-has previously collected information on his physical problem, the environment
-allows him to have an approach focused on simply declaring this information to
-build a valid ADAO case, to evaluate it, and to draw the physical results he
-needs
+Its main objective is **to provide the use of standard and robust data
+assimilation or optimization methods, in an efficient way, while remaining easy
+to setup, and providing a simplified path to help the implementation**. For the
+end user, who has previously collected information on his physical problem, the
+environment allows him to have an approach focused on simply declaring this
+information to build a valid ADAO case, to evaluate it, and to draw the
+physical results he needs
 
 The module covers a wide variety of practical applications, in a robust way,
 allowing real engineering applications, but also quick experimental methodology
 setup to be performed. Its methodological and numerical scalability give way to
-extend its applied domain. It is based on usage of other SALOME modules, namely
-YACS and EFICAS if they are available, and on usage of a generic underlying
-data assimilation library.
+extend its applied domain. It is based on usage of other Python or SALOME
+modules, in particular YACS and EFICAS if they are available, and on usage of a
+generic underlying data assimilation library.
index 55e98206c142d4ca54536a41af5c3c37c084d962..5f7efef1ab13a483ebc63365ea7cd9c0679579eb 100644 (file)
@@ -197,6 +197,7 @@ StoreSupplementaryCalculations
 
 - [Evensen94]_
 - [Burgers98]_
+- [Bishop01]_
 - [Evensen03]_
 - [Zupanski05]_
 - [WikipediaEnKF]_
index 72d96698b1c1c7598578a07fdf70911b9e0e57f2..9332d0bbcd660cf01b73f01faa2ca88b56ba9cc9 100644 (file)
@@ -21,7 +21,6 @@
 
    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
 
-.. index:: single: CHECKING_STUDY
 .. _section_ref_checking_keywords:
 
 List of commands and keywords for an ADAO checking case
@@ -29,13 +28,16 @@ List of commands and keywords for an ADAO checking case
 
 This set of commands is related to the description of a checking case, that is a
 procedure to check required properties on information, used somewhere else by a
-calculation case. The terms are ordered in alphabetical order, except the first,
-which describes the choice between calculation or checking.
+calculation case.
 
-The different commands are the following:
+The first term describes the choice between calculation or checking. In the
+graphical interface, the verification is imperatively indicated by the command:
 
 .. include:: snippets/CHECKING_STUDY.rst
 
+The other terms are ordered in alphabetical order. The different commands are
+the following:
+
 .. include:: snippets/AlgorithmParameters.rst
 
 .. include:: snippets/CheckingPoint.rst
index 32cd65d1874260237fb0fef4073517ddcca264df..f9307e7cb6c1f6ce0ae145a65ae1ed85423724c6 100644 (file)
@@ -83,8 +83,9 @@ the section :ref:`section_theory`.
 **[DocR]** Data assimilation or optimization calculation cases
 ============================================================================================
 
-This section describes the data assimilation or optimization algorithms
-available in ADAO, detailing their usage characteristics and their options.
+This section describes algorithmic choices to use data assimilation methods,
+optimization methods or methods with reduction, available in ADAO, detailing
+their usage characteristics and their options.
 
 Some examples on these commands usage are available in the section
 :ref:`section_tutorials_in_salome`, in the section
index dbd532ee4991a7ceb0d4b912ab85f43d3daed6d1..cb91761af8cb5168143edbdc30079c76141e69ba 100644 (file)
@@ -35,6 +35,8 @@ case.setObserver(
     Variable='Analysis',
     )
 #
+# Loop to obtain an analysis at each observation arrival
+#
 XaStep, VaStep = 0., 1.
 for i in range(1,len(Yobs)):
     case.setBackground         (Vector             = "%s"%float(XaStep))
index 276d2419f44d23e13b4ea475cfa8e31169e845a9..16a56a28618b523134b44dc0d8c11028f5de2b0d 100644 (file)
@@ -41,9 +41,10 @@ provenant de mesures expérimentales, ou observations, et de modèles numérique
 *a priori*, y compris des informations sur leurs erreurs. Certaines des
 méthodes incluses dans ce cadre sont également connues sous les noms
 d'*estimation de paramètres*, de *problèmes inverses*, d'*estimation
-bayésienne*, d'*interpolation optimale*, de *reconstruction de champs*, etc. De
-plus amples détails peuvent être trouvés dans la partie proposant
-:ref:`section_theory`.
+bayésienne*, d'*interpolation optimale*, de *reconstruction de champs*, etc. Le
+module ADAO offre actuellement plus de 100 méthodes algorithmiques différentes
+et permet l'étude d'environ 350 problèmes appliqués distincts. De plus amples
+détails peuvent être trouvés dans la partie proposant :ref:`section_theory`.
 
 La documentation de ce module est divisée en plusieurs grandes catégories,
 relatives à la documentation théorique (indiquée dans le titre de section par
@@ -66,9 +67,9 @@ expliquent comment utiliser une :ref:`section_gui_in_salome` ou une
 :ref:`section_reference`, avec trois sous-parties essentielles qui la composent
 et qui décrivent les commandes et des options d'algorithmes. Un
 :ref:`section_glossary`, des :ref:`section_notations`, une
-:ref:`section_bibliography` et un :ref:`genindex` développés complètent le
-document. Enfin, pour respecter les exigences de licence du module, n'oubliez
-pas de lire la partie :ref:`section_license`.
+:ref:`section_bibliography` et un index développé complètent le document.
+Enfin, pour respecter les exigences de licence du module, n'oubliez pas de lire
+la partie :ref:`section_license`.
 
 .. toctree::
    :caption: Table des matières
index bafe7d3ac0d872fd246826bf90cfbdc10191a030..85f09b00935645d85c8df14a883e16bef26e8402 100644 (file)
@@ -28,9 +28,9 @@ Introduction à ADAO
 ================================================================================
 
 Le but du module ADAO est **d'aider à l'usage de l'assimilation de données ou
-de l'optimisation en lien avec d'autres modules ou codes de simulation dans un
-contexte Python** [Python]_ **ou SALOME** [Salome]_. Le module ADAO fournit une
-interface simple à des algorithmes classiques d'assimilation de données ou
+de l'optimisation, en lien avec d'autres modules ou codes de simulation, dans
+un contexte Python** [Python]_ **ou SALOME** [Salome]_. Le module ADAO fournit
+une interface simple à des algorithmes classiques d'assimilation de données ou
 d'optimisation, ainsi que de tests ou vérifications. Il permet d'intégrer leur
 usage dans une étude Python ou SALOME. Les modules utilisateurs de calcul ou de
 simulation doivent fournir une ou plusieurs méthodes d'appel spécifiques afin
@@ -38,19 +38,20 @@ d'être appelable dans le cadre Python ou SALOME. En environnement SALOME, tous
 les modules natifs peuvent être utilisés grâce à l'intégration en Python ou en
 YACS.
 
-Son principal objectif est de **permettre l'usage de diverses méthodes
-standards d'assimilation de données ou d'optimisation, tout en restant facile à
-paramétrer, et en fournissant une démarche simplifiée pour aider à la mise en
-oeuvre**. Pour l'utilisateur final, qui a préalablement recueilli les
-informations sur son problème physique, l'environnement lui permet d'avoir une
-démarche centrée sur la simple déclaration de ces informations pour construire
-un cas ADAO valide, pour l'évaluer, et pour en tirer les résultats physiques
-dont il a besoin.
+Son principal objectif est de **permettre l'usage de méthodes standards et
+robustes d'assimilation de données ou d'optimisation, de manière performante,
+tout en restant facile à paramétrer, et en fournissant une démarche simplifiée
+pour aider à la mise en oeuvre**. Pour l'utilisateur final, qui a préalablement
+recueilli les informations sur son problème physique, l'environnement lui
+permet d'avoir une démarche centrée sur la simple déclaration de ces
+informations pour construire un cas ADAO valide, pour l'évaluer, et pour en
+tirer les résultats physiques dont il a besoin.
 
 Le module couvre une grande variété d'applications pratiques, de façon robuste,
 permettant des applications réelles, mais aussi d'effectuer de
 l'expérimentation méthodologique rapide. Son évolutivité, des points de vue
 méthodologique et numérique, permet aussi l'extension de son domaine
-d'application. Il est basé sur l'utilisation d'autres modules, à savoir YACS et
-EFICAS s'ils sont disponibles, et sur l'utilisation d'une bibliothèque et
-d'outils génériques sous-jacents d'assimilation de données.
+d'application. Il est basé sur l'utilisation d'autres modules Python ou SALOME,
+en particulier YACS et EFICAS s'ils sont disponibles, et sur l'utilisation
+d'une bibliothèque et d'outils génériques sous-jacents d'assimilation de
+données.
index 1c3084942869d36a671137ada212d78830b1a171..f981840b34ef95246b2906f2e104b354b3ab6ca3 100644 (file)
@@ -199,6 +199,7 @@ StoreSupplementaryCalculations
 
 - [Evensen94]_
 - [Burgers98]_
+- [Bishop01]_
 - [Evensen03]_
 - [Zupanski05]_
 - [WikipediaEnKF]_
index c9ab6e0d14421a53ef702d54c5a6eea34f0e4314..a895af71af6b5ffab082afc2508ab42665de86a8 100644 (file)
@@ -21,7 +21,6 @@
 
    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
 
-.. index:: single: CHECKING_STUDY
 .. _section_ref_checking_keywords:
 
 Liste des commandes et mots-clés pour un cas de vérification
@@ -29,13 +28,17 @@ Liste des commandes et mots-clés pour un cas de vérification
 
 Ce jeu de commandes est lié à la description d'un cas de vérification, qui est
 une procédure pour vérifier les propriétés d'une information requise, utilisée
-ailleurs par un cas de calcul. Les termes sont classés par ordre alphabétique,
-sauf le premier, qui décrit le choix entre le calcul ou la vérification.
+ailleurs par un cas de calcul.
 
-Les différentes commandes sont les suivantes:
+Le premier terme décrit le choix entre un calcul ou une vérification. Dans
+l'interface graphique, la vérification est désigné obligatoirement par la
+commande:
 
 .. include:: snippets/CHECKING_STUDY.rst
 
+Les autres termes sont classés par ordre alphabétique. Les différentes
+commandes sont les suivantes:
+
 .. include:: snippets/AlgorithmParameters.rst
 
 .. include:: snippets/CheckingPoint.rst
index f77b8be537390a1f12d0037d64f8e2cdfbace388..68d4f3e61a83770604b035984f778698ee150e67 100644 (file)
@@ -83,8 +83,9 @@ sont expliquées dans la section :ref:`section_theory`.
 **[DocR]** Cas d'assimilation de données ou d'optimisation
 ============================================================================================
 
-Cette section décrit les algorithmes d'assimilation de données ou
-d'optimisation disponibles dans ADAO, détaillant leurs caractéristiques
+Cette section décrit les choix algorithmiques pour utiliser des méthodes
+d'assimilation de données, des méthodes d'optimisation ou des méthodes avec
+réduction, disponibles dans ADAO, détaillant leurs caractéristiques
 d'utilisation et leurs options.
 
 Des exemples sur l'usage de ces commandes sont disponibles dans la section
index 3fc4fa9a33aa37fc914ebe2bf70dd7b5bbede5a6..95a52c5cc2da28fbd6ffc6090da552a633d0f6a6 100644 (file)
@@ -3,7 +3,7 @@
 Le filtre de Kalman peut être utilisé pour une **réanalyse des observations
 d'un modèle dynamique donné**. C'est parce que l'ensemble de l'historique
 complet de l'observation est déjà connu au début des fenêtres temporelles qu'on
-parle de *réanalyse*, même si l'analyse itérative conserve inconnues les
+parle de *réanalyse*, même si l'analyse itérative conserve comme inconnues les
 observations futures à un pas de temps donné.
 
 Cet exemple décrit l'estimation itérative d'une quantité physique constante
index 749f22e466195c6168e075833cf3b55d89d8ca72..24a8558f93a0a6b30aa0a5c27401a44c45e37559 100644 (file)
@@ -35,6 +35,8 @@ case.setObserver(
     Variable='Analysis',
     )
 #
+# Boucle pour obtenir une analyse à l'arrivée de chaque observation
+#
 XaStep, VaStep = 0., 1.
 for i in range(1,len(Yobs)):
     case.setBackground         (Vector             = "%s"%float(XaStep))