Salome HOME
Documentation improvements and post analysis
[modules/adao.git] / doc / fr / tui.rst
index 5b6bd7831c7383fb97ebc663a0dbab4000de47c8..c3df5b843ef4369872e8f1a6adf6710cf588b9e3 100644 (file)
@@ -38,7 +38,9 @@ cas de calcul TUI, on recommande de bien s'appuyer sur l'ensemble de la
 documentation du module ADAO, et de se reporter si nécessaire à l'interface
 graphique (GUI), pour disposer de l'ensemble des éléments permettant de
 renseigner correctement les commandes. Les notions générales et termes utilisés
-ici sont définis dans :ref:`section_theory`.
+ici sont définis dans :ref:`section_theory`. Comme dans l'interface graphique,
+on note que la démarche en TUI est destinée à créer et gérer un unique cas de
+calcul.
 
 .. _subsection_tui_creating:
 
@@ -539,7 +541,9 @@ Paramétrer le calcul, les sorties, etc.
     l'exécution.
 
 .. index:: single: Observer
+.. index:: single: Observer Template
 .. index:: single: setObserver
+.. index:: single: setObserver Template
 
 **setObserver** (*Variable, Template, String, Script, Info*)
     Cette commande permet de définir un *observer* sur une variable courante ou
@@ -555,19 +559,22 @@ Paramétrer le calcul, les sorties, etc.
     "*Info*" contient une chaîne de caractère d'information ou une chaine vide.
 
 .. index:: single: UserPostAnalysis
+.. index:: single: UserPostAnalysis Template
 .. index:: single: setUserPostAnalysis
 .. index:: single: setUserPostAnalysis Template
 
 **setUserPostAnalysis** (*Template, String, Script*)
     Cette commande permet de définir le traitement des paramètres ou des
     résultats après le déroulement de l'algorithme de calcul. Sa valeur est
-    définie comme nom de patron prédéfini, un fichier script ou une chaîne de
-    caractères. Cela permet de produire directement du code de post-processing
-    dans un cas ADAO. On peut d'utiliser les patrons disponibles par l'argument
-    "*Template*" (qui peut valoir "*AnalysisPrinter*", "*AnalysisSaver*" et
-    "*AnalysisPrinterAndSaver*"). Dans le cas d'une définition par "*Script*",
-    le fichier indiqué doit contenir uniquement les commandes que l'on aurait
-    pu mettre à la suite de l'exécution du calcul.
+    définie soit par un nom de patron prédéfini, soit par un nom de fichier
+    script, soit par une chaîne de caractères. Cela permet de produire
+    directement du code de post-processing dans un cas ADAO. On peut d'utiliser
+    les patrons disponibles par l'argument "*Template*" (qui peut valoir
+    "*AnalysisPrinter*", "*AnalysisSaver*" et "*AnalysisPrinterAndSaver*").
+    Dans le cas d'une définition par "*Script*", le fichier indiqué doit
+    contenir uniquement les commandes que l'on aurait pu mettre à la suite de
+    l'exécution du calcul. Remarque importante : ce traitement n'est exécuté
+    que lorsque le cas est exécuté en TUI ou exporté en YACS.
 
 Effectuer le calcul
 +++++++++++++++++++
@@ -654,6 +661,29 @@ externes au cas.
     autre les commandes établissant le cas de calcul en cours. Certains
     formats ne sont disponibles qu'en entrée ou qu'en sortie.
 
+De plus, on peut obtenir une information simple sur le cas d'étude tel que
+défini par l'utilisateur en utilisant directement la commande "*print*" de Python
+sur le cas, à toute étape lors de sa construction. Par exemple::
+
+    from numpy import array, matrix
+    from adao import adaoBuilder
+    case = adaoBuilder.New()
+    case.set( 'AlgorithmParameters', Algorithm='3DVAR' )
+    case.set( 'Background',          Vector=[0, 1, 2] )
+    print(case)
+
+dont le résultat est ici::
+
+    ================================================================================
+    ADAO Study report
+    ================================================================================
+
+      - AlgorithmParameters command has been set with values:
+            Algorithm='3DVAR'
+
+      - Background command has been set with values:
+            Vector=[0, 1, 2]
+
 .. _subsection_tui_advanced:
 
 Exemples plus avancés de cas de calcul TUI ADAO
@@ -678,9 +708,10 @@ Les hypothèses du cas utilisateur sont les suivantes. On suppose :
 #. que l'utilisateur dispose en Python d'une fonction de simulation physique appelée ``simulation``, préalablement (bien) testée, qui transforme les 3 paramètres en résultats similaires aux observations,
 #. que l'exploitation indépendante, que l'utilisateur veut faire, est représentée ici par l'affichage simple de l'état initial, de l'état optimal, de la simulation en ce point, des états intermédiaires et du nombre d'itérations d'optimisation.
 
-Pour effectuer de manière simple cet essai de cas de calcul TUI, on se donne par
-exemple les entrées suivantes, parfaitement arbitraires, en construisant les
-observations par simulation pour se placer dans un cas d'expériences jumelles::
+Pour effectuer de manière simple cet essai de cas de calcul TUI, on se donne
+par exemple les entrées suivantes, parfaitement arbitraires, en construisant
+les observations par simulation pour se placer dans un cas d'expériences
+jumelles (pour mémoire, voir la démarche :ref:`section_methodology_twin`)::
 
     #
     # Construction artificielle d'un exemple de données utilisateur