3 ================================================================================
4 Utiliser le module ADAO
5 ================================================================================
7 .. |eficas_new| image:: images/eficas_new.png
10 .. |eficas_save| image:: images/eficas_save.png
13 .. |eficas_saveas| image:: images/eficas_saveas.png
16 .. |eficas_yacs| image:: images/eficas_yacs.png
19 .. |yacs_compile| image:: images/yacs_compile.png
23 Cette section présente l'usage du module ADAO dans la plateforme SALOME. Il est
24 complété par la description détaillée de l'ensemble des commandes et mots-clés
25 dans la section :ref:`section_reference`, par des procédures avancées d'usage
26 dans la section :ref:`section_advanced`, et par des exemples dans la section
27 :ref:`section_examples`.
29 Procédure logique pour construire un cas ADAO
30 ---------------------------------------------
32 La construction d'un cas ADAO suit une démarche simple pour définir l'ensemble
33 des données d'entrée, et ensuite générer un diagramme complet d'exécution
34 utilisé dans YACS. De nombreuses variations existent pour la définition des
35 données d'entrée, mais la séquence logique reste inchangée.
37 De manière générale, l'utilisateur doit connaître ses données d'entrées,
38 requises pour mettre au point une étude d'assimilation de données. Ces données
39 peuvent être disponibles dans SALOME ou non.
41 **Fondamentalement, la procédure d'utilisation de ADAO comprend les étapes
44 #. **Activez le module ADAO et utiliser l'éditeur graphique (GUI),**
45 #. **Construire et/ou modifier le cas ADAO et l'enregistrer,**
46 #. **Exporter le cas ADAO comme un schéma YACS,**
47 #. **Compléter et modifier le schéma YACS, et l'enregistrer,**
48 #. **Exécutez le cas YACS et obtenir les résultats.**
50 Chaque étape est détaillée dans la section suivante.
52 ÉTAPE 1 : Activer le module ADAO et utiliser l'interface graphique d'édition (GUI)
53 ----------------------------------------------------------------------------------
55 Comme toujours pour un module, il doit être préalablement activé en
56 sélectionnant le bouton de module approprié (ou le menu) dans la barre d'outils
57 de SALOME. S'il n'existe aucune étude SALOME chargée, un menu contextuel
58 apparaît, permettant de choisir entre la création d'une nouvelle étude, ou
59 l'ouverture d'une étude déjà existante:
62 .. image:: images/adao_activate.png
65 **Activation du module ADAO dans SALOME**
67 En choisissant le bouton "*Nouveau*", un éditeur intégré de cas EFICAS [#]_ sera
68 ouvert, en même temps que le "*navigateur d'objets*" standard. On peut alors
69 cliquer sur le bouton "*Nouveau*"(ou choisir l'entrée "*Nouveau*" dans le dans
70 le menu principal "*ADAO*") pour créer un nouveau cas ADAO, et on obtient :
73 .. image:: images/adao_viewer.png
77 **L'éditeur EFICAS pour la définition des cas dans le module ADAO**
79 ÉTAPE 2 : Créer et modifier le cas ADAO, et l'enregistrer
80 ---------------------------------------------------------
82 Pour construire un cas en utilisant EFICAS, on doit passer par une série de
83 sous-étapes, en choisissant, à chaque étape, un mot-clé puis en remplissant ses
86 L'éditeur structuré indique des types hiérarchiques, des valeurs ou des
87 mots-clés autorisés. Les mots-clés incomplets ou incorrects sont identifiés par
88 un indicateur d'erreur visuel rouge. Les valeurs possibles sont indiquées pour
89 les mots-clés par la définition d'une liste limitée de valeurs, et les entrées
90 adaptées sont données pour les autres mots-clés. Des messages d'aide sont
91 fournis de manière contextuelle aux places réservées de l'éditeur.
93 Un nouveau cas est mis en place avec la liste minimale des commandes. Toutes les
94 commandes ou les mots-clés obligatoires sont déjà présents, aucun d'eux ne peut
95 être supprimé. Des mots-clés optionnels peuvent être ajoutés en les choisissant
96 dans une liste de suggestions de ceux autorisés pour la commande principale, par
97 exemple la commande "*ASSIMILATION_STUDY*". À titre d'exemple, on peut ajouter
98 un mot-clé "*AlgorithmParameters*", comme décrit dans la dernière partie de la
99 section :ref:`section_examples`.
101 A la fin de ces actions, lorsque tous les champs ou les mots-clés ont été
102 correctement définis, chaque ligne de l'arborescence des commandes doit
103 présenter un drapeau vert. Cela signifie que l'ensemble du cas est valide et
104 dûment rempli (et qu'il peut être sauvegardé).
106 .. _adao_jdcexample00:
107 .. image:: images/adao_jdcexample01.png
111 **Exemple d'un cas ADAO valide**
113 Au final, il faut enregistrer le cas ADAO en utilisant le bouton "*Enregistrer*"
114 |eficas_save|, ou le bouton "*Enregistrer sous*" |eficas_saveas|, ou en
115 choisissant l'entrée "*Enregistrer/ Enregistrer sous*" dans le menu "*ADAO*". Il
116 est alors demandé un emplacement, à choisir dans l'arborescence des fichiers, et
117 un nom, qui sera complété par l'extension "*.comm*" utilisée pour les fichiers
118 JDC d'EFICAS. Cette action va générer une paire de fichiers décrivant le cas
119 ADAO, avec le même nom de base, le premier présentant une extension "*.comm*" et
120 le second une extension "*.py*" [#]_.
122 ÉTAPE 3 : Exporter le cas ADAO comme un schéma YACS
123 ---------------------------------------------------
125 Lorsque le cas ADAO est complété, il doit être converti ou exporté sous la forme
126 d'un schéma YACS [#]_ pour pouvoir exécuter le calcul d'assimilation de
127 données. Cela peut être réalisé facilement en utilisant le bouton "*Exporter
128 vers YACS*" |eficas_yacs|, ou de manière équivalente en choisissant l'entrée
129 "*Exporter vers YACS*" dans le menu principal "*ADAO*", ou dans le menu
130 contextuel du cas dans le navigateur d'objets SALOME.
132 .. _adao_exporttoyacs01:
133 .. image:: images/adao_exporttoyacs.png
137 **Sous-menu "Exporter vers YACS" pour générer le schéma YACS à partir d'un cas ADAO**
139 Cela conduit à générer automatiquement un schéma YACS, et à activer le module
140 YACS sur ce schéma. Le fichier YACS, associé au schéma, est stocké dans le même
141 répertoire et avec le même nom de base de fichier que le cas ADAO enregistré,
142 changeant simplement son extension en "*.xml*". Attention, *si le nom de fichier
143 XML existe déjà, le fichier est écrasé sans avertissement sur le remplacement du
146 ÉTAPE 4 : Compléter et modifier le schéma YACS, et l'enregistrer
147 ----------------------------------------------------------------
149 .. index:: single: Analysis
151 Lorsque le schéma YACS est généré et ouvert dans SALOME à travers le l'interface
152 graphique du module YACS, on peut modifier ou compléter le schéma comme tout
153 schéma YACS standard. Des noeuds ou des blocs peuvent être ajoutés, copiés ou
154 modifiés pour élaborer une analyse complexe, ou pour insérer des capacités
155 d'assimilation de données ou d'optimisation dans des schémas de calculs YACS
158 Le principal complément nécessaire dans un schéma YACS est une étape de
159 post-processing. L'évaluation du résultat doit être réalisé dans le contexte
160 physique de simulation utilisé par la procédure d'assimilation de données. Le
161 post-processing peut être fournit à travers le mot-clé "*UserPostAnalysis*"
162 d'ADAO sous la forme d'un fichier de script ou d'une chaîne de caractères, par
163 des patrons ("templates"), ou peut être construit comme des noeuds YACS. Ces
164 deux manières de construire le post-processing peuvent utiliser toutes les
167 Dans le détail, le schéma YACS dispose d'un port de sortie "*algoResults*" dans
168 le bloc de calcul, qui donne accès à un objet de type "*pyobj*" nommé ci-aprés
169 "*ADD*", qui contient tous les résultats de calcul. Ces résultats peuvent être
170 obtenus en récupérant les variables nommées stockées au cours des calculs.
171 L'information principale est la variable "*Analysis*", qui peut être obtenue par
172 une commande python (par exemple dans un noeud script intégré ("in-line script
173 node") ou un script fourni à travers le mot-clé "*UserPostAnalysis*"::
175 Analysis = ADD.get("Analysis")[:]
177 "*Analysis*" est un objet complexe, similaire à une liste de valeurs calculées à
178 chaque étape du calcul d'assimilation. Pour obtenir et afficher l'évaluation
179 optimale de l'état par assimilation de données, dans un script fournit par
180 l'intermédiaire du mot-clé "*UserPostAnalysis*", on peut utiliser::
182 Xa = ADD.get("Analysis")[-1]
183 print "Optimal state:", Xa
186 Cette variable ``Xa`` est un vecteur de valeurs, qui représente la solution du
187 problème d'évaluation par assimilation de données ou par optimisation, notée
188 :math:`\mathbf{x}^a` dans la section :ref:`section_theory`.
190 Une telle méthode peut être utilisée pour imprimer les résultats, ou pour les
191 convertir dans des structures qui peuvent être nécessaires à un post-processing
192 natif ou externe à SALOME. Un exemple simple est disponible dans la section
193 :ref:`section_examples`.
195 ÉTAPE 5 : Exécuter le schéma YACS et obtenir les résultats
196 ----------------------------------------------------------
198 Le schéma YACS est maintenant complet et peut être exécuté. La paramétrisation
199 et l'exécution de ce cas YACS est entièrement compatible avec la manière
200 standard de traiter un schéma YACS, comme décrit dans le *Guide de l'utilisateur
203 Pour rappeler la manière la plus simple de procéder, le schéma YACS doit être
204 compilé en utilisant le bouton |yacs_compile|, ou l'entrée équivalente du menu
205 YACS, pour préparer le schéma à son exécution. Ensuite, le schéma compilé peut
206 être démarré, exécuté pas à pas ou en utilisant des points d'arrêt, etc.
208 La sortie standard est restituée dans la "*fenêtre de sortie de YACS*" (ou
209 "*YACS Container Log*"), à laquelle on accède par un clic droit sur la fenêtre
210 "*proc*" dans l'interface graphique YACS. Les erreurs sont présentées soit
211 dans la "*fenêtre de sortie de YACS*", ou à la ligne de commande dans la fenêtre
212 de commandes (si l'environnement SALOME a été lancé par une commande explicite,
213 et non par un menu ou une icône de bureau). Par exemple, la sortie de l'exemple
214 simple ci-dessus est de la forme suivante::
216 Entering in the assimilation study
217 Name is set to........: Test
218 Algorithm is set to...: Blue
219 Launching the analyse
221 Optimal state: [0.5, 0.5, 0.5]
223 présentée dans la "*fenêtre de sortie de YACS*".
225 L'exécution peut aussi être conduite en utilisant un script de commandes shell,
226 comme décrit dans la section :ref:`section_advanced`.
228 .. [#] Pour de plus amples informations sur EFICAS, voir le *module EFICAS* et son aide disponible dans l'environnement SALOME.
230 .. [#] Pour de plus amples informations sur YACS, voir le *Guide utilisateur du module YACS* disponible dans le menu principal *Aide* de l'environnement SALOME.
232 .. [#] Ce fichier python intermédiaire peut aussi être utilisé comme décrit dans la section :ref:`section_advanced`.
