named ``<SALOME main installation dir>`` and has to be replaced by the good one
in the shell file template.
-When an ADAO command file is build by the ADAO GUI EFICAS editor and saved, if
+When an ADAO command file is build by the ADAO graphical editor and saved, if
it is named for example "AdaoStudy1.comm", then a companion file named
"AdaoStudy1.py" is automatically created in the same directory. It is named
``<ADAO Python file>`` in the template, and it is converted to YACS as an
This method allows for example to edit the YACS XML scheme in TUI, or to gather
results for further use.
+.. _section_advanced_observer:
+
Getting information on special variables during the ADAO calculation in YACS
-----------------------------------------------------------------------------
variables ``var`` and ``info``. The variable ``var`` is to be used in the same
way as for the final ADD object, that is as a list/tuple object.
-Some templates are available when editing the ADAO case in EFICAS editor. These
-simple scripts can be customized by the user, either at the EFICAS edition
+Some templates are available when editing the ADAO case in graphical editor.
+These simple scripts can be customized by the user, either at the EFICAS edition
stage, or at the YACS edition stage, to improve the tuning of the ADAO
calculation in YACS.
[SalomeMeca]_ for example. So, if it does not work in your case, check your
operator function before and during enabling parallelism...
-**In case of doubt, it is recommended NOT TO ACTIVATE this parallelism.**
+.. warning::
+
+ in case of doubt, it is recommended NOT TO ACTIVATE this parallelism.
Switching from a version of ADAO to a newer one
-----------------------------------------------
All various modifications could be done from this template hypothesis.
-Special case of controlled evolution or observation operator
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. _section_ref_operator_control:
+
+Special case of controled evolution or observation operator
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
In some cases, the evolution or the observation operator is required to be
controlled by an external input control, given *a priori*. In this case, the
.. _section_ref_options_Algorithm_Parameters:
Description of options of an algorithm in "*AlgorithmParameters*"
---------------------------------------------------------------
+-----------------------------------------------------------------
Each algorithm can be controlled using some specific options or parameters. They
are given through the "*Parameters*" optional command included in the mandatory
command "*AlgorithmParameters*".
There are 3 practical methods for the user to provide these options. The method
-is determined as follows in EFICAS:
+is determined as follows in the graphical user interface:
#. firstly using the "*Parameters*" keyword in the "*AlgorithmParameters*" command, which allows to choose between "*Defaults*" (use of explicit pre-filled keywords by default parameters values) and "*Dict*" (use of a dictionary to fill the necessary keywords),
#. then secondly, only in the "*Dict*" case of "*Parameters*", by the included keyword "*FROM*" which allows to choose between a string entry and a Python script file entry.
+++++++++++++++++++++++++++++++++++++++++++++++++
To give the parameters values by explicit pre-filled keywords, directly in the
-EFICAS graphical interface, the user selects the type "*Defaults*" in the
-keyword "*Parameters*", then the keywords in the given "*Parameters[Algo]*" list
-which appears, linked with the chosen algorithm, as shown in the following
-figure:
+graphical interface, the user selects the type "*Defaults*" in the keyword
+"*Parameters*", then the keywords in the given "*Parameters[Algo]*" list which
+appears, linked with the chosen algorithm, as shown in the following figure:
.. adao_algopar_defaults:
.. image:: images/adao_algopar_defaults.png
algorithm, and the defined values are not keeped if the user changes the
algorithm.
-Second method : using a string in EFICAS
-++++++++++++++++++++++++++++++++++++++++
+Second method : using a string in the graphical interface
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-To give the parameters values as a string, directly in the EFICAS graphical
-interface, the user selects the type "*Dict*" in the keyword "*Parameters*",
-then the type "*String*" in the keyword "*FROM*" of the "*Dict*" command which
-appears, as shown in the following figure:
+To give the parameters values as a string, directly in the graphical interface,
+the user selects the type "*Dict*" in the keyword "*Parameters*", then the type
+"*String*" in the keyword "*FROM*" of the "*Dict*" command which appears, as
+shown in the following figure:
.. :adao_algopar_string
.. image:: images/adao_algopar_string.png
++++++++++++++++++++++++++++++++++++++++++++++++++
To give the parameters values as an external Python script file, the user
-selects in EFICAS the type "*Dict*" in the keyword "*Parameters*", then the type
-"*Script*" in the keyword "*FROM*" of the "*Dict*" command which appears, as
-shown in the following figure:
+selects in the graphical interface the type "*Dict*" in the keyword
+"*Parameters*", then the type "*Script*" in the keyword "*FROM*" of the "*Dict*"
+command which appears, as shown in the following figure:
.. :adao_algopar_script
.. image:: images/adao_algopar_script.png
être remplacé par le bon dans le modèle "type" de fichier shell.
Lorsqu'un fichier de commande ADAO est construit par l'interface d'édition
-EFICAS d'ADAO et est enregistré, s'il est nommé par exemple "EtudeAdao1.comm",
-alors un fichier compagnon nommé "EtudeAdao1.py" est automatiquement créé dans
-la même répertoire. Il est nommé ``<Fichier Python ADAO>`` dans le modèle
-"type", et il est converti vers YACS comme un ``<Schéma xml YACS ADAO>``.
-Ensuite, il peut être exécuté en mode console en utilisant la commande standard
-en mode console de YACS (voir la documentation YACS pour de plus amples
-informations).
+graphique d'ADAO et est enregistré, s'il est nommé par exemple
+"EtudeAdao1.comm", alors un fichier compagnon nommé "EtudeAdao1.py" est
+automatiquement créé dans la même répertoire. Il est nommé ``<Fichier Python
+ADAO>`` dans le modèle "type", et il est converti vers YACS comme un ``<Schéma
+xml YACS ADAO>``. Ensuite, il peut être exécuté en mode console en utilisant la
+commande standard en mode console de YACS (voir la documentation YACS pour de
+plus amples informations).
Dans l'exemple, on choisit de démarrer et arrêter le serveur d'application
SALOME dans le même script, ce qui n'est pas nécessaire, mais utile pour éviter
Cette démarche permet par exemple d'éditer le schéma YACS XML en mode texte TUI,
ou de rassembler les résultats pour un usage ultérieur.
+.. _section_advanced_observer:
+
Obtenir des informations sur des variables spéciales au cours d'un calcul ADAO en YACS
--------------------------------------------------------------------------------------
liste/tuple.
Des modèles ("templates") sont disponibles lors de l'édition le cas ADAO dans
-l'éditeur EFICAS. Ces scripts simples peuvent être adaptés par l'utilisateur,
-soit dans l'étape EFICAS, ou dans l'étape d'édition YACS, pour améliorer
-l'adaptation du calcul ADAO dans YACS.
+l'éditeur graphique. Ces scripts simples peuvent être adaptés par l'utilisateur,
+soit dans l'étape d'édition EFICAS, ou dans l'étape d'édition YACS, pour
+améliorer l'adaptation du calcul ADAO dans YACS.
A titre d'exemple, voici un script trés simple (similaire au modèle
"*ValuePrinter*") utilisable pour afficher la valeur d'une variable surveillée::
Toutes les modifications envisageables peuvent être faites à partir de cette
hypothèse de squelette.
+.. _section_ref_operator_control:
+
Cas spécial d'un opérateur d'évolution avec contrôle
++++++++++++++++++++++++++++++++++++++++++++++++++++
.. _section_ref_options_Algorithm_Parameters:
Description des options d'un algorithme dans "*AlgorithmParameters*"
------------------------------------------------------------------
+--------------------------------------------------------------------
Chaque algorithme peut être contrôlé en utilisant des options ou des paramètres
particuliers. Ils sont donnés à travers la commande optionnelle "*Parameters*"
incluse dans la commande obligatoire "*AlgorithmParameters*".
Il y a 3 méthodes pratiques pour l'utilisateur pour fournir ces options. La
-méthode est déterminée de la manière suivante dans EFICAS :
+méthode est déterminée de la manière suivante dans l'interface graphique
+d'édition :
#. premièrement à l'aide du mot-clé "*Parameters*" dans la commande "*AlgorithmParameters*", qui permet de choisir entre "*Defaults*" (utilisation de mots-clés explicites pré-remplis par les valeurs par défaut des paramètres) et "*Dict*" (utilisation d'un dictionnaire pour renseigner les mots-clés nécessaires),
#. puis deuxièmement, uniquement dans le cas "*Dict*" de "*Parameters*", par le mot-clé "*FROM*" inclus qui permet de choisir entre une entrée par chaîne de caractères ou une entrée par fichier de script Python.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Pour donner les valeurs des paramètres par les mots-clés explicites pré-remplis,
-directement dans l'interface graphique EFICAS, l'utilisateur sélectionne le type
+directement dans l'interface graphique, l'utilisateur sélectionne le type
"*Defaults*" dans le mot-clé "*Parameters*", puis les mots-clés dans la liste
prévue "*Parameters[Algo]*" qui apparaît, associée à l'algorithme choisi, comme
montré dans la figure qui suit :
paramètres autorisés pour un algorithme donné, et les valeurs définies ne sont
pas conservées si l'utilisateur change d'algorithme.
-Seconde méthode : utiliser une chaîne de caractères dans EFICAS
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Seconde méthode : utiliser une chaîne de caractères dans l'interface graphique
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Pour donner les valeurs des paramètres par une chaîne de caractères, directement
-dans l'interface graphique EFICAS, l'utilisateur sélectionne le type "*Dict*"
-dans le mot-clé "*Parameters*", puis le type "*String*" dans le mot-clé "*FROM*"
-de la commande "*Dict*" qui apparaît, comme montré dans la figure qui suit :
+dans l'interface graphique, l'utilisateur sélectionne le type "*Dict*" dans le
+mot-clé "*Parameters*", puis le type "*String*" dans le mot-clé "*FROM*" de la
+commande "*Dict*" qui apparaît, comme montré dans la figure qui suit :
.. adao_algopar_string:
.. image:: images/adao_algopar_string.png
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Pour donner les valeurs des paramètres par un fichier de script Python externe,
-l'utilisateur sélectionne dans EFICAS le type "*Dict*" dans le mot-clé
-"*Parameters*", puis le type "*Script*" dans le mot-clé "*FROM*" de la commande
-"*Dict*" qui apparaît, comme montré dans la figure qui suit :
+l'utilisateur sélectionne dans l'interface graphique le type "*Dict*" dans le
+mot-clé "*Parameters*", puis le type "*Script*" dans le mot-clé "*FROM*" de la
+commande "*Dict*" qui apparaît, comme montré dans la figure qui suit :
.. :adao_algopar_script
.. image:: images/adao_algopar_script.png
