]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Documentation corrections
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 15 Jan 2018 20:08:25 +0000 (21:08 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 15 Jan 2018 20:08:25 +0000 (21:08 +0100)
doc/en/index.rst
doc/en/tui.rst
doc/fr/images/yacs_containerlog.png
doc/fr/index.rst
doc/fr/intro.rst
doc/fr/tui.rst

index 7c4296c07605118b255a825588712e20cb1f8ef1..c2f9b8ae96ab4477682d06f9ad4471968dd56eeb 100644 (file)
@@ -31,9 +31,10 @@ ADAO documentation
    :align: center
    :alt: ADAO logo
 
-The ADAO module provides **data assimilation and optimization** features in
-SALOME context. It is based on usage of other SALOME modules, namely YACS and
-EFICAS, and on usage of a generic underlying data assimilation library.
+**The ADAO module provides data assimilation and optimization** features in
+SALOME context [Salome]_. It is based on usage of other SALOME modules, namely
+YACS and EFICAS, and on usage of a generic underlying data assimilation
+library.
 
 Briefly stated, Data Assimilation is a methodological framework to compute the
 optimal estimate of the inaccessible true value of a system state over time. It
index 5a5e6b3d1325bb668e8b806cc31ff8065947d48f..bab60a5e9c5292283a4dd532554a731f66ec86d3 100644 (file)
@@ -491,8 +491,8 @@ Perform the calculation
     This command launches the complete calculation in the execution environment
     chosen by the keyword *Executor*. This environment can be the current
     Python interpreter, without interaction with YACS (using the value
-    "*Python*"), or the one of YACS (using the value "*YACS*"). If a file is
-    given in the keyword *SaveCaseInFile*, it will be used to save the
+    "*Python*"), or the one of YACS (using the value "*YACS*" [YACS]_). If a
+    file is given in the keyword *SaveCaseInFile*, it will be used to save the
     associated version of commands file for the given execution environment.
     During the execution, the usual outputs (standard and error) are the one of
     the chosen environment. If necessary (and if possible), the ADAO algorithms
index 4f9ff724b1ede0e40d733887df5542a290b1cf87..4839361b23212584e8a716cc3ec57f2270aaad1f 100644 (file)
Binary files a/doc/fr/images/yacs_containerlog.png and b/doc/fr/images/yacs_containerlog.png differ
index 5658a7f1415309a4368c7325f1871e8da5e31bee..541769e74db2fede5ab7be9f1565a790063531e1 100644 (file)
@@ -31,10 +31,11 @@ Documentation ADAO
    :align: center
    :alt: Logo ADAO
 
-Le module ADAO fournit des fonctionnalités d'**assimilation de données et
-d'optimisation** dans un contexte SALOME. Il est basé sur l'utilisation d'autres
-modules, à savoir YACS et EFICAS, et sur l'utilisation d'une bibliothèque et des
-outils génériques sous-jacents d'assimilation de données.
+**Le module ADAO fournit des fonctionnalités d'assimilation de données et
+d'optimisation** dans un contexte SALOME [Salome]_. Il est basé sur
+l'utilisation d'autres modules, à savoir YACS et EFICAS, et sur l'utilisation
+d'une bibliothèque et d'outils génériques sous-jacents d'assimilation de
+données.
 
 En bref, l'assimilation de données est un cadre méthodologique pour calculer
 l'estimation optimale de la valeur réelle (inaccessible) de l'état d'un système
index f6d96feda38a0eb30fb00dbdfbfa54032eb6055d..f033b46b8ccffc9d8078b0b9fc2f723a03c8ac03 100644 (file)
@@ -27,8 +27,8 @@
 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
+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
 SALOME**. Le module ADAO fournit une interface à des algorithmes classiques
 d'assimilation de données ou d'optimisation, et permet d'intégrer leur usage
 dans une étude SALOME. Les modules de calcul ou de simulation doivent fournir
index 6557d08fed88d39bfe1689d5a644f548324a9217..e566cabc254fe9343e0d1e1e7b62bfb7b2f89fd6 100644 (file)
@@ -511,12 +511,12 @@ Effectuer le calcul
     Cette commande lance le calcul complet dans l'environnement d'exécution
     choisi par le mot-clé *Executor*. Cet environnement peut être celui de
     l'interpréteur Python, sans interaction avec YACS (demandé par la valeur
-    "*Python*"), ou celui de YACS (demandé par la valeur "*YACS*"). Si un
-    fichier est indiqué dans le mot-clé *SaveCaseInFile*, il sera utilisé
+    "*Python*"), ou celui de YACS (demandé par la valeur "*YACS*" [YACS]_). Si
+    un fichier est indiqué dans le mot-clé *SaveCaseInFile*, il sera utilisé
     pour enregistrer la version associée du fichier de commande pour
     l'environnement d'exécution requis. Lors de l'exécution, les sorties
-    courantes (standard et d'erreur) sont celles de l'environnement choisi.
-    On dispose si nécessaire (ou si possible) du parallélisme interne des
+    courantes (standard et d'erreur) sont celles de l'environnement choisi. On
+    dispose si nécessaire (ou si possible) du parallélisme interne des
     algorithmes dans ADAO, du parallélisme de YACS, et du parallélisme interne
     du ou des codes de simulation utilisés.