Adding multi-functions input capabilities (2)

[modules/adao.git] / doc / en / tui.rst

diff --git a/doc/en/tui.rst b/doc/en/tui.rst
index 5a5e6b3d1325bb668e8b806cc31ff8065947d48f..aef68ed82c3b17f6d1ae9e56a172912ef59e1d23 100644 (file)
--- a/doc/en/tui.rst
+++ b/doc/en/tui.rst
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2017 EDF R&D
+   Copyright (C) 2008-2018 EDF R&D
 
    This file is part of SALOME ADAO module.
 
@@ -54,8 +54,8 @@ ADAO calculation case. All the data are explicitly defined inside the script in
 order to make the reading easier. The whole set of commands is the following
 one::
 
-    from numpy import array
-    import adaoBuilder
+    from numpy import array, matrix
+    from adao import adaoBuilder
     case = adaoBuilder.New()
     case.set( 'AlgorithmParameters', Algorithm='3DVAR' )
     case.set( 'Background',          Vector=[0, 1, 2] )
@@ -84,7 +84,7 @@ commands, the ``case`` object name of the ADAO TUI calculation case being let
 free to the user choice::
 
     from numpy import array, matrix
-    import adaoBuilder
+    from adao import adaoBuilder
     case = adaoBuilder.New()
 
 It is recommended to import by default the ``numpy`` module or some of its
@@ -272,8 +272,8 @@ are done by importing the interface module "*adaoBuilder*" and by by invoking
 its method "*New()*" as illustrated in the following lines (the ``case`` object
 name being let free to the user choice)::
 
-    from numpy import array
-    import adaoBuilder
+    from numpy import array, matrix
+    from adao import adaoBuilder
     case = adaoBuilder.New()
 
 It is recommended by default to always import the ``numpy`` module (or some of
@@ -456,6 +456,16 @@ Setting the calculation, outputs, etc.
     the file must contain the two variables "*Algorithm*" and "*Parameters*" (or
     "*AlgorithmParameters*" equivalently).
 
+.. index:: single: setName
+
+**setName** (*String*)
+    This command allows to set a short title for the calculation case.
+
+.. index:: single: setDirectory
+
+**setDirectory** (*String*)
+    This command allows to set the execution standard directory.
+
 .. index:: single: setDebug
 
 **setDebug** ()
@@ -491,8 +501,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
@@ -514,6 +524,49 @@ Get the calculation results separately
     :ref:`section_ref_output_variables` and to the individual documentations of
     the algorithms.
 
+Saving, loading or converting calculation case commands
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+The saving or loading of a calculation case deals with quantities and actions
+that are linked by the previous commands, excepted case external operations
+(such as, for example, post-processing that can be developped after the
+calculation cas). The registered or loaded commands remain fully compatible
+with these Python external case operations.
+
+.. index:: single: load
+.. index:: single: FileName
+.. index:: single: Content
+.. index:: single: Object
+.. index:: single: Formater
+
+**load** (*FileName, Content, Object, Formater*)
+    This command allows to read or load a calculation case, from a file named
+    "*FileName*" or a content in memory by "*Content*" or "*Object*". The
+    "*Formater*" keyword can indicate "*TUI*" for commands of textual
+    application programming interface, and "*COM*" for commands of COMM type
+    coming from EFICAS interface for ADAO.
+
+.. index:: single: dump
+
+**dump** (*FileName, Formater*)
+    This command allows to save, in a file named "*FileName*", the commands of
+    the current calculation case. The "*Formater*" keyword can indicate "*TUI*"
+    for commands of textual application programming interface, and "*YACS*" for
+    commands of type YACS.
+
+.. index:: single: convert
+.. index:: single: FileNameFrom
+.. index:: single: ContentFrom
+.. index:: single: ObjectFrom
+.. index:: single: FormaterFrom
+.. index:: single: FileNameTo
+.. index:: single: FormaterTo
+
+**convert** (*FileNameFrom, ContentFrom, ObjectFrom, FormaterFrom, FileNameTo, FormaterTo*)
+    This command allows to convert directly from a known format to an another
+    one the commands establishing the current calculation case. Some formats
+    are only available as input or as output.
+
 .. _subsection_tui_advanced:
 
 More advanced examples of ADAO TUI calculation case
@@ -566,7 +619,7 @@ observations by simulation in order to set a twin experiments case::
 The set of commands that can be used is the following::
 
     import numpy
-    import adaoBuilder
+    from adao import adaoBuilder
     #
     # Formatting entries
     # ------------------
@@ -635,8 +688,9 @@ The command set execution gives the following result::
     Optimal state...................: [ 2.  3.  4.]
     Simulation at optimal state.....: [  2.   6.  12.  20.]
 
-As it should be in twin experiments, it is found that we get correctly the
-parameters that were used to artificially build the observations.
+As it should be in twin experiments, when we trust mainly in observations, it
+is found that we get correctly the parameters that were used to artificially
+build the observations.
 
 .. Reconciliation de courbes a l'aide de MedCoupling
 .. +++++++++++++++++++++++++++++++++++++++++++++++++