From: Jean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Date: Sat, 7 Mar 2020 17:25:57 +0000 (+0100)
Subject: Updating documentation for nextStep option
X-Git-Tag: V9_5_0a2~4
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=950d00513b648d9b51f964eba70a333cae3dd120;p=modules%2Fadao.git

Updating documentation for nextStep option
---

diff --git a/doc/en/tui.rst b/doc/en/tui.rst
index 1cbbb9f..7306f82 100644
--- a/doc/en/tui.rst
+++ b/doc/en/tui.rst
@@ -290,6 +290,8 @@ the inputs in GUI interface, as described in section of
 :ref:`section_ref_entry_types`. The verification of the adequacy of variables is
 done either on their definition, or at runtime.
 
+.. index:: single: Stored
+
 In each command, the boolean keyword "*Stored*" indicates whether you optionally
 want to store the quantity defined, for disposal during calculation or at the
 output. The default is not to store, and it is recommended to keep this default.
@@ -508,18 +510,23 @@ Perform the calculation
 .. index:: single: execute
 .. index:: single: Executor
 .. index:: single: SaveCaseInFile
+.. index:: single: nextStep
 
-**execute** (*Executor, SaveCaseInFile*)
+**execute** (*Executor, SaveCaseInFile, nextStep*)
     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*" [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
-    internal parallelism, the parallelism of YACS, and the internal parallelism
-    of the simulation code(s) used, are available.
+    chosen by the keyword *Executor*, which is defined by default with respect
+    of the launching environment. 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*" [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. The boolean
+    keyword "*nextStep*" indicates whether the run starts from the result of
+    the previous run without storing it (value "*True*") or not (value
+    "*False*", by default). During the execution, the usual outputs (standard
+    and error) are the one of the chosen environment. If necessary (and if
+    possible), the ADAO algorithms internal parallelism, the parallelism of
+    YACS, and the internal parallelism of the simulation code(s) used, are
+    available.
 
 Get the calculation results separately
 ++++++++++++++++++++++++++++++++++++++
diff --git a/doc/fr/tui.rst b/doc/fr/tui.rst
index 9890006..592f398 100644
--- a/doc/fr/tui.rst
+++ b/doc/fr/tui.rst
@@ -301,6 +301,8 @@ entrées en interface GUI, décrits dans la section des
 :ref:`section_ref_entry_types`. La vérification de l'adéquation des grandeurs se
 fait soit lors de leur définition, soit lors de l'exécution.
 
+.. index:: single: Stored
+
 Dans chaque commande, le mot-clé booléen "*Stored*" permet d'indiquer si l'on
 veut éventuellement la stocker la grandeur définie, pour en disposer en cours de
 calcul ou en sortie. Le choix par défaut est de ne pas stocker, et il est
@@ -530,19 +532,23 @@ Effectuer le calcul
 .. index:: single: execute
 .. index:: single: Executor
 .. index:: single: SaveCaseInFile
+.. index:: single: nextStep
 
-**execute** (*Executor, SaveCaseInFile*)
+**execute** (*Executor, SaveCaseInFile, nextStep*)
     Cette commande lance le calcul complet dans l'environnement d'exécution
-    choisi par le mot-clé *Executor*. Cet environnement peut être celui de
+    choisi par le mot-clé *Executor*, qui est défini par défaut selon
+    l'environnement de lancement. Cet environnement peut être celui de
     l'interpréteur Python, sans interaction avec YACS (demandé par la valeur
     "*Python*"), ou celui de YACS (demandé par la valeur "*YACS*" [YACS]_). Si
     un fichier est indiqué dans le mot-clé *SaveCaseInFile*, il sera utilisé
     pour enregistrer la version associée du fichier de commande pour
-    l'environnement d'exécution requis. Lors de l'exécution, les sorties
-    courantes (standard et d'erreur) sont celles de l'environnement choisi. On
-    dispose si nécessaire (ou si possible) du parallélisme interne des
-    algorithmes dans ADAO, du parallélisme de YACS, et du parallélisme interne
-    du ou des codes de simulation utilisés.
+    l'environnement d'exécution requis. Le mot-clé booléen "*nextStep*" indique
+    que l'exécution repart du résultat de la précédente exécution sans la
+    stocker (valeur "*True*") ou non (valeur "*False*", par défaut). Lors de
+    l'exécution, les sorties courantes (standard et d'erreur) sont celles de
+    l'environnement choisi. On dispose si nécessaire (ou si possible) du
+    parallélisme interne des algorithmes dans ADAO, du parallélisme de YACS, et
+    du parallélisme interne du ou des codes de simulation utilisés.
 
 Obtenir séparément les résultats de calcul
 ++++++++++++++++++++++++++++++++++++++++++