]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation review corrections V9_5_0 V9_5_0rc2 V9_5_0rc3
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 22 Jun 2020 13:03:37 +0000 (15:03 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 22 Jun 2020 13:03:37 +0000 (15:03 +0200)
14 files changed:
doc/en/advanced.rst
doc/en/notations.rst
doc/en/ref_observers_requirements.rst
doc/en/ref_operator_requirements.rst
doc/en/ref_options_AlgorithmParameters.rst
doc/en/tutorials_in_salome.rst
doc/fr/advanced.rst
doc/fr/methodology.rst
doc/fr/notations.rst
doc/fr/ref_algorithm_NonLinearLeastSquares.rst
doc/fr/ref_observers_requirements.rst
doc/fr/ref_operator_requirements.rst
doc/fr/ref_options_AlgorithmParameters.rst
doc/fr/tutorials_in_salome.rst

index 3f4f04abee416c496b241ab61a9252d8ab27b826..5650feef5158b151dc9e3949487d184c5533b199 100644 (file)
@@ -292,11 +292,11 @@ Python interface.
 
 .. _section_advanced_eficas_gui:
 
-Using the EFICAS graphical interface as an ADAO TUI command
------------------------------------------------------------
+Using the ADAO EFICAS graphical interface as an ADAO TUI command
+----------------------------------------------------------------
 
-To make it easier to quickly edit an ADAO command file with EFICAS (JDC, or
-pair of files ".comm/.py", that are together in a directory), you can launch
+To make it easier to quickly edit an ADAO command file with ADAO EFICAS (JDC,
+or pair of files ".comm/.py", that are together in a directory), you can launch
 the graphical user interface from the Python interpreter. To do this, in a
 Python interpreter obtained from the "SALOME shell", the following commands are
 used::
index 03642f19bc05d766926baacbaef894fbafab8386..d527f123bfe5c723cdf7307d5e44c88f34760660 100644 (file)
@@ -44,7 +44,7 @@ File type and naming conventions rely heavily on the extensions of the files
 themselves. Some of them are briefly specified here, without being exhaustive:
 
 - extension ``.py``   : data or commands text file of Python source type
-- extension ``.comm`` : commands text file of EFICAS type
+- extension ``.comm`` : commands text file of ADAO EFICAS type
 - extension ``.xml``  : data text file of XML type or commands (for YACS, not exclusive)
 - extension ``.txt``  : data text file with space separator
 - extension ``.dat``  : data text file with space separator
index 6905b1b7cda37624d2ad226c6cb214f9c75a691f..485c2e1fc093d2991f779597f07cfcdb30c058bf 100644 (file)
@@ -55,8 +55,8 @@ template or pattern (entry of type"*Template*") available by default in ADAO
 when using the graphical editor and detailed in the following part
 :ref:`section_ref_observers_templates`. These templates are simple scripts that
 can be tuned by the user, either in the integrated edition stage of the case
-with EFICAS, or in the edition stage of the schema before execution, to improve
-the ADAO case performance in the SALOME execution supervisor YACS.
+with ADAO EFICAS, or in the edition stage of the schema before execution, to
+improve the ADAO case performance in the SALOME execution supervisor YACS.
 
 In the textual interface (TUI) of ADAO (see the part :ref:`section_tui`), the
 same information can be given with the command "*setObserver*" applied to a
index 7dda4f8ff6d80f4418ad06e71f911c97927906ef..941484dc783e68b964b30358aa2790f6240c82f1 100644 (file)
@@ -101,13 +101,13 @@ First functional form: one direct operator only
 The first one consist in providing only one function, potentially non-linear,
 and to approximate the associated tangent and adjoint operators.
 
-This is done in ADAO by using in the graphical interface EFICAS the keyword
-"*ScriptWithOneFunction*" for the description by a script. In the textual
-interface, it is the keyword "*OneFunction*", possibly combined with "*Script*"
-keyword depending on whether it is a function or a script. If it is by external
-script, the user must provide a file containing a function that has the
-mandatory name "*DirectOperator*". For example, an external script can follow
-the generic template::
+This is done in ADAO by using, in the ADAO graphical interface EFICAS, the
+keyword "*ScriptWithOneFunction*" for the description by a script. In the
+textual interface, it is the keyword "*OneFunction*", possibly combined with
+"*Script*" keyword depending on whether it is a function or a script. If it is
+by external script, the user must provide a file containing a function that has
+the mandatory name "*DirectOperator*". For example, an external script can
+follow the generic template::
 
     def DirectOperator( X ):
         """ Direct non-linear simulation operator """
index dc90da2b096e057a159dd85c627c32695c9c7073..cc72d33800af243c251880ef4f7ceb46251e1711 100644 (file)
@@ -36,7 +36,7 @@ command "*AlgorithmParameters*".
 
 There are 3 practical methods for the user of the EFICAS graphical user
 interface of ADAO (GUI) to provide these options. The method is determined as
-follows in the EFICAS graphical user interface:
+follows in the ADAO EFICAS graphical user interface:
 
 #. firstly using the "*Parameters*" keyword in the "*AlgorithmParameters*"
    command, which allows to choose between "*Defaults*" (use of explicit
index 6497692eb44fd6a4cd7cbdcfbd97e4ded1f45fc9..0b7fbfd17f5bf3ce1676b15c597d80d367592cd6 100644 (file)
@@ -433,12 +433,11 @@ Skeletons of the scripts describing the setup
 
 We give here the essential parts of each script used afterward to build the
 ADAO case. Remember that using these scripts in real Python files requires to
-correctly define the path to imported modules or codes (even if the module is in
-the same directory that the importing Python file. We indicate the path
-adjustment using the mention ``"# INSERT PHYSICAL SCRIPT PATH"``), the encoding
-if necessary, etc. The indicated file names for the following scripts are
-arbitrary. Examples of complete file scripts are available in the ADAO examples
-standard directory.
+correctly define the path to imported modules or codes (even if the module is
+in the same directory that the importing Python file. One have to mention the
+encoding if necessary, etc. The indicated file names for the following scripts
+are arbitrary. Examples of complete file scripts are available in the ADAO
+examples standard directory.
 
 We first define the true state :math:`\mathbf{x}^t` and some convenient matrix
 building function, in a Python script file named
@@ -523,7 +522,9 @@ convenience:
         return numpy.array( HX )
 
 We does not need the linear companion operators ``"TangentOperator"`` and
-``"AdjointOperator"`` because they will be approximated using ADAO capabilities.
+``"AdjointOperator"`` because they will be approximated using ADAO
+capabilities. Detailed information on these operators can be found in the
+:ref:`section_ref_operator_requirements`.
 
 We insist on the fact that these non-linear operator ``"DirectOperator"``,
 tangent operator ``"TangentOperator"`` and adjoint operator
@@ -581,6 +582,9 @@ the following parameters can be defined in a Python script file named
             [ 0., 4. ],              # Bound on the second parameter
             [ 0., None ],            # Bound on the third parameter
             ],
+        "StoreSupplementaryCalculations" : [
+            "CurrentState",
+            ],
     }
 
 Finally, it is common to post-process the results, retrieving them after the
@@ -644,7 +648,7 @@ an estimation case with explicit data definition`_ previous section.
 
 Using the simple linear operator :math:`\mathbf{H}` from the Python script file
 ``Physical_simulation_functions.py`` in the ADAO examples standard directory,
-the results will look like:
+the results will look like (it may depend on the system):
 ::
 
     xt = [1 2 3]
index 5e7e4db440d548db232e01f40b4ee9fe2d6c414e..d6ba88c5a963402aa88c6ac2d84f62449e33550e 100644 (file)
@@ -307,11 +307,11 @@ l'interface API/TUI en Python standard.
 
 .. _section_advanced_eficas_gui:
 
-Utiliser l'interface graphique EFICAS comme une commande TUI d'ADAO
--------------------------------------------------------------------
+Utiliser l'interface graphique EFICAS d'ADAO comme une commande TUI d'ADAO
+--------------------------------------------------------------------------
 
-Pour faciliter l'édition rapide avec EFICAS d'un fichier de commandes ADAO
-(JDC, ou paire de fichiers ".comm/.py", qui se trouvent ensemble dans un
+Pour faciliter l'édition rapide avec EFICAS d'ADAO d'un fichier de commandes
+ADAO (JDC, ou paire de fichiers ".comm/.py", qui se trouvent ensemble dans un
 répertoire), on peut lancer l'interface graphique depuis l'interpréteur Python.
 Pour cela, dans un interpréteur Python obtenu depuis le "SALOME shell", on
 utilise les commandes suivantes::
index 0991ce5765e515e755b8ec5d597068a4a0db3607..fb6e94d7563beb024cf64ae27e079c4ccd69f98a 100644 (file)
@@ -30,7 +30,7 @@
 Cette section présente un méthodologie générique pour construire une étude
 d'Assimilation de Données ou d'Optimisation. Elle décrit les étapes
 conceptuelles pour établir de manière indépendante cette étude. Elle est
-indépendante de tout outil, mais le module ADAO permet de mettre en oeuvre
+indépendante de tout outil, mais le module ADAO permet de mettre en œuvre
 efficacement une telle étude. Les notations sont les mêmes que celles utilisées
 dans :ref:`section_theory`.
 
@@ -92,7 +92,7 @@ En pratique, les méthodes d'optimisation peuvent requérir une information de
 type gradient de la simulation par rapport aux inconnues. Dans ce cas, le
 gradient explicite du code doit être donné, ou le gradient numérique doit être
 établi. Sa qualité est en relation avec la stabilité ou la régularité du code de
-simulation, et elle doit être vérifiée avec soin avant de mettre en oeuvre les
+simulation, et elle doit être vérifiée avec soin avant de mettre en œuvre les
 calculs d'optimisation. Des conditions spécifiques doivent être utilisées pour
 ces vérifications.
 
index e777c2ea1994dbf36192838791060c8194d39cdc..b71ad9dd05ef928a76c717a7a0fa33d552a5d941 100644 (file)
@@ -48,7 +48,7 @@ extensions des fichiers eux-mêmes. On en précise brièvement certaines ici, sa
 être exhaustifs :
 
 - extension ``.py``   : fichier texte de données ou commandes de type source Python
-- extension ``.comm`` : fichier texte de données de commandes EFICAS
+- extension ``.comm`` : fichier texte de données de commandes EFICAS d'ADAO
 - extension ``.xml``  : fichier texte de données de type XML (pour YACS, non exclusif)
 - extension ``.txt``  : fichier texte de données à séparateur espace
 - extension ``.dat``  : fichier texte de données à séparateur espace
index e88d7034a8303106049fa61ff6ae9c1afc8d45cb..1b5d56a713e85d817ef8c86d8ecac56d99cb089b 100644 (file)
@@ -118,7 +118,7 @@ StoreSupplementaryCalculations
 *Astuce pour cet algorithme :*
 
     Comme la commande *"BackgroundError"* est requise pour TOUS les algorithmes
-    de calcul dans l'interface graphique ADAO EFICAS, vous devez fournir une
+    de calcul dans l'interface graphique EFICAS d'ADAO, vous devez fournir une
     valeur, malgré le fait que cette commande ne soit pas nécessaire pour cet
     algorithme, et n'est donc pas utilisée. La manière la plus simple est de
     donner "1" comme un STRING.
index 5831e96e9787838ec5649351275d986c0dd3b4b2..db1cbf844c98698ee8a328f6b45380567c2839c0 100644 (file)
@@ -52,12 +52,12 @@ la figure qui suit :
 L'"*observer*" peut être fourni sous la forme d'un script explicite (entrée de
 type "*String*"), d'un script contenu dans un fichier externe (entrée de type
 "*Script*"), ou en utilisant un modèle (entrée de type "*Template*") fourni par
-défaut dans ADAO lors de l'usage de l'éditeur graphique EFICAS et détaillé dans
-la partie :ref:`section_ref_observers_templates` qui suit. Ces derniers sont
-des scripts simples qui peuvent être adaptés par l'utilisateur, soit dans
-l'étape d'édition intégrée du cas avec EFICAS, soit dans l'étape d'édition du
-schéma avant l'exécution, pour améliorer la performance du calcul ADAO dans le
-superviseur d'exécution de SALOME.
+défaut dans ADAO lors de l'usage de l'éditeur graphique EFICAS d'ADAO et
+détaillé dans la partie :ref:`section_ref_observers_templates` qui suit. Ces
+derniers sont des scripts simples qui peuvent être adaptés par l'utilisateur,
+soit dans l'étape d'édition intégrée du cas avec EFICAS d'ADAO, soit dans
+l'étape d'édition du schéma avant l'exécution, pour améliorer la performance du
+calcul ADAO dans le superviseur d'exécution de SALOME.
 
 Dans l'interface textuelle (TUI) d'ADAO (voir la partie :ref:`section_tui`),
 les mêmes informations peuvent être données à l'aide de la commande
index 34d42e9b645cb0c56efe96958f8510193e6a657e..39e98c3848d4884b826de4ae131b408902a0ff28 100644 (file)
@@ -104,8 +104,8 @@ Première forme fonctionnelle : un seul opérateur direct
 La première consiste à ne fournir qu'une seule fonction, potentiellement non
 linéaire, et à approximer les opérateurs tangent et adjoint associés.
 
-Ceci est fait dans ADAO en utilisant dans l'interface graphique EFICAS le
-mot-clé "*ScriptWithOneFunction*" pour la description par un script. Dans
+Ceci est fait dans ADAO en utilisant, dans l'interface graphique EFICAS d'ADAO,
+le mot-clé "*ScriptWithOneFunction*" pour la description par un script. Dans
 l'interface textuelle, c'est le mot-clé "*OneFunction*", éventuellement combiné
 avec le mot-clé "*Script*" selon que c'est une fonction ou un script. Si c'est
 par script externe, l'utilisateur doit fournir un fichier contenant une
index b7730040e7d2232a07f8ea31a8c609851c18a201..d2d67a7d201b58a39d6958612bbd721fec922527 100644 (file)
@@ -36,7 +36,7 @@ incluse dans la commande obligatoire "*AlgorithmParameters*".
 
 Il y a 3 méthodes pratiques pour l'utilisateur de l'interface graphique EFICAS
 d'ADAO (GUI) pour fournir ces options. La méthode est déterminée de la manière
-suivante dans l'interface graphique EFICAS :
+suivante dans l'interface graphique EFICAS d'ADAO :
 
 #. premièrement à l'aide du mot-clé "*Parameters*" dans la commande
    "*AlgorithmParameters*", qui permet de choisir entre "*Defaults*"
index 8fbb9296bf6b55fb52d657e63d20bd436d75762a..b9ce86f89edb9576b86146eeb3307915c366c80f 100644 (file)
@@ -458,12 +458,11 @@ Squelettes des scripts décrivant les conditions d'expérience
 On donne ici les éléments essentiels de chaque script utilisé par la suite pour
 construire le cas ADAO. On rappelle que l'utilisation de ces scripts dans de
 réels fichiers Python nécessite de définir correctement le chemin de modules ou
-des codes importés (même si le module est dans le même répertoire que le fichier
-Python qui l'importe. On indique le chemin à renseigner en utilisant la mention
-``"# INSERT PHYSICAL SCRIPT PATH"``), l'encodage si nécessaire, etc. Les noms de
-fichiers indiqués pour les scripts qui suivent sont arbitraires. Des exemples
-complets de fichiers scripts sont disponibles dans le répertoire standard des
-exemples ADAO.
+des codes importés (même si le module est dans le même répertoire que le
+fichier Python qui l'importe. On doit aussi indiquer l'encodage si nécessaire,
+etc. Les noms de fichiers indiqués pour les scripts qui suivent sont
+arbitraires. Des exemples complets de fichiers scripts sont disponibles dans le
+répertoire standard des exemples ADAO.
 
 On définit en premier lieu l'état vrai :math:`\mathbf{x}^t` et une fonction
 utiles à la construction de matrices, dans un fichier script Python nommé
@@ -550,7 +549,8 @@ ici par facilité :
 
 On n'a pas besoin des opérateurs linéaires associés ``"TangentOperator"`` et
 ``"AdjointOperator"`` car ils vont être approximés en utilisant les capacités
-d'ADAO.
+d'ADAO. Des informations détaillées sur ces opérateurs peuvent être trouvées
+dans les :ref:`section_ref_operator_requirements`.
 
 On insiste sur le fait que ces opérateurs non-linéaire ``"DirectOperator"``,
 linéaire tangent ``"TangentOperator"`` et linéaire adjoint ``"AdjointOperator"``
@@ -610,6 +610,9 @@ définis dans un fichier de script Python nommé
             [ 0., 4. ],              # Bound on the second parameter
             [ 0., None ],            # Bound on the third parameter
             ],
+        "StoreSupplementaryCalculations" : [
+            "CurrentState",
+            ],
     }
 
 Enfin, il est courant de post-traiter les résultats, en les récupérant aprés la
@@ -677,7 +680,8 @@ explicite des données`_.
 
 En utilisant l'opérateur linéaire simple :math:`\mathbf{H}` du fichier script
 Python ``Physical_simulation_functions.py`` disponible dans le répertoire
-standard des exemples, les résultats ressemblent à :
+standard des exemples, les résultats ressemblent à (cela peut dépendre du
+système) :
 ::
 
     xt = [1 2 3]