From: Jean-Philippe ARGAUD Date: Mon, 15 Jan 2018 20:08:25 +0000 (+0100) Subject: Documentation corrections X-Git-Tag: V8_5_0rc1~34 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=500ff48ce1773c989ee170bd9b00d04b2798786b;p=modules%2Fadao.git Documentation corrections --- diff --git a/doc/en/index.rst b/doc/en/index.rst index 7c4296c..c2f9b8a 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -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 diff --git a/doc/en/tui.rst b/doc/en/tui.rst index 5a5e6b3..bab60a5 100644 --- a/doc/en/tui.rst +++ b/doc/en/tui.rst @@ -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 diff --git a/doc/fr/images/yacs_containerlog.png b/doc/fr/images/yacs_containerlog.png index 4f9ff72..4839361 100644 Binary files a/doc/fr/images/yacs_containerlog.png and b/doc/fr/images/yacs_containerlog.png differ diff --git a/doc/fr/index.rst b/doc/fr/index.rst index 5658a7f..541769e 100644 --- a/doc/fr/index.rst +++ b/doc/fr/index.rst @@ -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 diff --git a/doc/fr/intro.rst b/doc/fr/intro.rst index f6d96fe..f033b46 100644 --- a/doc/fr/intro.rst +++ b/doc/fr/intro.rst @@ -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 diff --git a/doc/fr/tui.rst b/doc/fr/tui.rst index 6557d08..e566cab 100644 --- a/doc/fr/tui.rst +++ b/doc/fr/tui.rst @@ -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.