From 6812fc4bc4b68fd810bc31e2d29fbadd945f422a Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Fri, 14 May 2021 13:56:14 +0200 Subject: [PATCH] Minor documentation review corrections (3) --- doc/en/intro.rst | 41 +++++++++++++++++++++-------------------- doc/fr/intro.rst | 44 ++++++++++++++++++++++---------------------- 2 files changed, 43 insertions(+), 42 deletions(-) diff --git a/doc/en/intro.rst b/doc/en/intro.rst index 788ab13..092dfd1 100644 --- a/doc/en/intro.rst +++ b/doc/en/intro.rst @@ -29,25 +29,26 @@ 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** -[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 -Python or SALOME study. Calculation or simulation user modules have to provide -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 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 +[Python]_ **or SALOME context** [Salome]_. It provides a simple interface to +many robust and powerful data assimilation or optimization algorithms, with or +without reduction, as well as testing and verification aids. It allows to +integrate these tools in a Python or SALOME study. + +Its main objective is to **provide the use of standard and robust data +assimilation or optimization methods, in a usual numerical simulation study +approach, in an efficient way, while remaining easy to setup, and by providing +a simplified approach 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 centered on the simple declaration of this +information to build a valid ADAO case, to then evaluate it, and to get 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 Python or SALOME -modules, in particular YACS and EFICAS if they are available, and on usage of a -generic underlying data assimilation library. +allowing for real world engineering applications, and also for performing quick +methodological experimentation. It is based on the use of other Python or +SALOME modules, in particular YACS and EFICAS if available, and on the use of +an underlying generic data assimilation library and tools. The computational or +simulation user modules must provide one or more specific calling methods in +order to be callable in the Python or SALOME framework. In the SALOME +environment, all native modules can be used through integration in Python or +YACS. diff --git a/doc/fr/intro.rst b/doc/fr/intro.rst index b8b095b..6b6967d 100644 --- a/doc/fr/intro.rst +++ b/doc/fr/intro.rst @@ -29,29 +29,29 @@ 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 -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 -d'être appelables 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. +un contexte Python** [Python]_ **ou SALOME** [Salome]_. Il fournit une +interface simple à de nombreux algorithmes robustes et performants +d'assimilation de données ou d'optimisation, avec ou sans réduction, ainsi que +des aides aux tests et aux vérifications. Il permet d'intégrer ces outils dans +une étude Python ou SALOME. 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. +robustes d'assimilation de données ou d'optimisation, dans une démarche usuelle +d'étude en simulation numérique, 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 ensuite 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 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. +permettant des applications réelles, et aussi d'effectuer de l'expérimentation +méthodologique rapide. 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. Les modules utilisateurs de calcul ou de simulation +doivent fournir une ou plusieurs méthodes d'appel spécifiques afin d'être +appelables 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. -- 2.39.2