.. _execxml:
-Exécution d'un schéma de calcul en mode console
+Executing a calculation scheme in console mode
========================================================
-Pour exécuter un schéma de calcul, au format XML, en mode console, il faut disposer d'une installation
-de SALOME bien configurée. Dans tout ce qui suit, on utilisera le mode d'exécution de SALOME
-à partir d'une `application SALOME <http://nepal.der.edf.fr/pub/SALOME_userguide/KERNEL4/doc/salome/gui/KERNEL/SALOME_Application.html>`_.
-
- 1. lancer SALOME : ./runAppli -t depuis le répertoire d'application, par exemple (on peut le faire de
- n'importe quel autre répertoire).
- 2. exécuter le superviseur YACS : ./runSession driver schema.xml
- 3. stopper SALOME : ./runSession shutdownSalome.py pour arrêter proprement ou ./runSession killSalome.py pour
- un arrêt brutal
-
-Il est possible de configurer une session d'exécution puis d'exécuter YACS et de stopper SALOME
-au sein de cette session en faisant :
-
- 2. initialiser la session : ./runSession
- 3. exécuter le superviseur YACS : driver schema.xml
- 4. stopper SALOME : shutdownSalome.py ou killSalome.py
- 5. sortir de la session : CTRL+D
-
-Le superviseur YACS en mode console (driver) accepte quelques options pour paramétrer
-son exécution::
-
- Usage: driver [OPTION...] graph.xml
- driver -- a SALOME YACS graph executor
-
- -d, --display=level Display dot files: 0=never to 3=very often
- -e, --dump-on-error[=file] Stop on first error and dump state
- -f, --dump-final[=file] dump final state
- -l, --load-state=file Load State from a previous partial execution
- -s, --stop-on-error Stop on first error
- -v, --verbose Produce verbose output
- -x, --save-xml-schema[=file] dump xml schema
- -?, --help Give this help list
- --usage Give a short usage message
- -V, --version Print program version
-
-Voici quelques utilisations typiques de driver.
-
-Exécution standard
+
+A well-configured SALOME installation is necessary to execute a calculation scheme in the XML format in console mode.
+SALOME execution mode from a SALOME application will be used in the remainder of this document.
+
+Steps to run a calculation scheme from the application directory:
+
+1. run SALOME: ./salome -t
+2. execute the YACS supervisor: ./salome shell -- driver schema.xml
+3. stop every SALOME session: ./salome killall
+
+Steps 2 and 3 can be done from inside a SALOME session. YACS can be executed and SALOME can be stopped within this session as follows:
+
+1. initialise the session: ./salome shell
+2. execute the YACS supervisor: driver schema.xml
+3. stop SALOME: shutdownSalome.py or killSalome.py
+4. exit from the session: CTRL+D
+
+The YACS supervisor in console (driver) mode accepts a few options to set parameters for its execution::
+
+ Usage: driver [OPTION...] graph.xml
+ driver -- a SALOME YACS graph executor
+
+ -d, --display=level Display dot files: 0=never to 3=very often
+ (default 0)
+ -e, --dump-on-error[=file] Stop on first error and dump state
+ -f, --dump-final[=file] dump final state
+ -g, --dump[=nbsec] dump state
+ -i, --init_port[=value] Initialisation value of a port, specified as
+ bloc.node.port=value.
+ -k, --kill-port=port Kill Salome application running on the specified
+ port if the driver process is killed (with SIGINT
+ or SIGTERM)
+ -l, --load-state=file Load State from a previous partial execution
+ -r, --reset=level Reset the schema before execution: 0=nothing,
+ 1=reset error nodes to ready state (default 0)
+ -s, --stop-on-error Stop on first error
+ -t, --shutdown=level Shutdown the schema: 0=no shutdown to 3=full
+ shutdown (default 1)
+ -v, --verbose Produce verbose output
+ -x, --save-xml-schema[=file] dump xml schema
+ -?, --help Give this help list
+ --usage Give a short usage message
+ -V, --version Print program version
+
+The following gives a few typical uses of the driver.
+
+Standard execution
--------------------
-Lors d'une exécution standard, le superviseur lit le fichier XML qui décrit le schéma,
-l'exécute et produit un compte-rendu d'erreurs (voir :ref:`errorreport`) s'il y a lieu::
+During a standard execution, the supervisor reads the XML file that describes the scheme, executes it and then produces
+an error report (see :ref:`errorreport`) if necessary::
driver schema.xml
-
-Exécution avec affichage des états des noeuds pendant l'exécution
+
+Execution displaying states of nodes during execution
----------------------------------------------------------------------
::
driver --display=1 schema.xml
+
-Exécution avec sauvegarde de l'état final du schéma
----------------------------------------------------------
+Execution saving the final state of the scheme
+----------------------------------------------------------------------
::
driver --dump-final=mystate.xml schema.xml
-Exécution avec chargement de l'état initial du schéma
----------------------------------------------------------
+Execution loading the initial state of the scheme
+----------------------------------------------------------------------
::
driver --load-state=mystate.xml schema.xml
+.. _xml_shutdown:
+
+How to configure schema shutdown
+---------------------------------------------
+No shutdown::
+
+ driver --shutdown=0 schema.xml
+
+Full shutdown::
+
+ driver --shutdown=3 schema.xml
+
+Restart a schema with reset of nodes in error
+----------------------------------------------------------------------
+::
+
+ driver --reset=1 --load-state=mystate.xml schema.xml
+
+Execute a scheme and save the state of execution every 30 seconds
+----------------------------------------------------------------------
+::
+
+ driver -g30 -fmystate.xml schema.xml
+
+Change the values of some input ports before execution
+----------------------------------------------------------------------
+::
+
+ driver -imynode.i=5 -imynode.d=.7 -imynode.b=False -imynode.s=lili schema.xml
+
+In this example, the ports "i", "d", "b" and "s" of the node "mynode" are initialized and the schema is launched.
+
+Only the ports of the following types can be initialized this way:
+
+ - int
+ - double
+ - bool
+ - string
+
+How to manage several SALOME sessions
+----------------------------------------------------------------------
+When you need to launch several SALOME session to execute several schemas in parallel, you have to
+store the SALOME session number to be able to shutdown or kill one of the sessions but not all of them.
+The session number can be stored in a file by using the --ns-port-log argument of the runAppli command.
+
+Here is an example with 2 SALOME sessions:
+
+1. Launch first SALOME session with execution of a schema::
+
+ <appli>/salome -t --ns-port-log=/tmp/session1.log
+ <appli>/salome shell -- driver schema1.xml
+
+2. Launch second SALOME session with execution of another schema::
+
+ <appli>/salome -t --ns-port-log=/tmp/session2.log
+ <appli>/salome shell -- driver schema2.xml
+
+3. Shutdown first session::
+
+ <appli>/salome kill `cat /tmp/session1.log`
+
+4. Kill second session::
+
+ <appli>/salome kill `cat /tmp/session2.log`
+
+
