Salome HOME
Updating copyright date information
[modules/adao.git] / doc / fr / tui.rst
index fc372687bd1d904cda0e761c0d860018e1a624e5..5b9e43e9a81bd086385a7dc17f656815d7eae2c7 100644 (file)
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2015 EDF R&D
+   Copyright (C) 2008-2016 EDF R&D
 
    This file is part of SALOME ADAO module.
 
@@ -23,6 +23,7 @@
 
 .. index:: single: TUI
 .. index:: single: API/TUI
+.. index:: single: adaoBuilder
 .. _section_tui:
 
 ================================================================================
@@ -85,7 +86,7 @@ On d
 calcul TUI ADAO. Les commandes elles-mêmes sont détaillées juste après dans
 l':ref:`subsection_tui_commands`.
 
-L'initialisation et la création d'une étude se fait par les commandes suivantes,
+La création et l'initialisation d'une étude se font par les commandes suivantes,
 le nom ``case`` de l'objet du cas de calcul TUI ADAO étant quelconque, au choix
 de l'utilisateur::
 
@@ -280,6 +281,22 @@ Le choix de l'une ou l'autre des syntaxes est librement laiss
 selon son contexte d'usage. Dans la suite, par souci de clarté, on définit les
 commandes selon la seconde syntaxe.
 
+Création d'un cas de calcul en interface textuelle TUI
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+La création et l'initialisation d'un cas de calcul en interface textuelle TUI se
+font en important le module d'interface "*adaoBuilder*" et en invoquant sa
+méthode "*New()*" comme illustré dans les quelques lignes suivantes (le nom
+``case`` de l'objet étant quelconque, au choix de l'utilisateur)::
+
+    from numpy import array
+    import adaoBuilder
+    case = adaoBuilder.New()
+
+Il est recommandé par principe de toujours importer le module ``numpy`` (ou ses
+constructeurs particuliers, comme celui d'``array``) pour faciliter ensuite son
+usage dans les commandes elle-mêmes.
+
 Définir les données de calcul
 +++++++++++++++++++++++++++++
 
@@ -476,19 +493,15 @@ Param
 
 **setObserver** (*Variable, Template, String, Script, Info*)
     Cette commande permet de définir un *observer* sur une variable courante ou
-    finale du calcul. On se reportera à la description de la manière
-    d':ref:`section_advanced_observer`, et à la :ref:`section_reference` pour
-    savoir quelles sont les quantités observables. On définit comme un
-    "*String*" le corps de l'*observer*, en utilisant une chaine de caractères
-    incluant si nécessaire des sauts de lignes. On recommande d'utiliser les
-    patrons disponibles par l'argument "*Template*". On dispose des patrons
-    simples suivants : "ValuePrinter", "ValueSeriePrinter", "ValueSaver",
-    "ValueSerieSaver", "ValuePrinterAndSaver", "ValueSeriePrinterAndSaver",
-    "ValueGnuPlotter", "ValueSerieGnuPlotter", "ValuePrinterAndGnuPlotter",
-    "ValueSeriePrinterAndGnuPlotter", "ValuePrinterSaverAndGnuPlotter",
-    "ValueSeriePrinterSaverAndGnuPlotter". Dans le cas d'une définition par
-    "*Script*", le fichier indiqué doit contenir uniquement le corps de la
-    fonction, comme décrit dans la manière d':ref:`section_advanced_observer`.
+    finale du calcul. On se reportera à la description des
+    :ref:`ref_observers_requirements` pour avoir leur liste et leur format, et à
+    la :ref:`section_reference` pour savoir quelles sont les quantités
+    observables. On définit comme un "*String*" le corps de l'*observer*, en
+    utilisant une chaine de caractères incluant si nécessaire des sauts de
+    lignes. On recommande d'utiliser les patrons disponibles par l'argument
+    "*Template*". Dans le cas d'une définition par "*Script*", le fichier
+    indiqué doit contenir uniquement le corps de la fonction, comme décrit dans
+    les :ref:`ref_observers_requirements`.
 
 Effectuer le calcul 
 +++++++++++++++++++