doc/fr/tui.rst

   1 ..
   2    Copyright (C) 2008-2019 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. index:: single: TUI
  25 .. index:: single: API/TUI
  26 .. index:: single: adaoBuilder
  27 .. _section_tui:
  28
  29 ================================================================================
  30 **[DocR]** Interface textuelle pour l'utilisateur (TUI/API)
  31 ================================================================================
  32
  33 Cette section présente des méthodes avancées d'usage du module ADAO à l'aide de
  34 son interface de programmation textuelle (API/TUI). Cette interface permet de
  35 créer un objet de calcul de manière similaire à la construction d'un cas par
  36 l'interface graphique (GUI). Dans le cas où l'on désire réaliser à la main le
  37 cas de calcul TUI, on recommande de bien s'appuyer sur l'ensemble de la
  38 documentation du module ADAO, et de se reporter si nécessaire à l'interface
  39 graphique (GUI), pour disposer de l'ensemble des éléments permettant de
  40 renseigner correctement les commandes. Les notions générales et termes utilisés
  41 ici sont définis dans :ref:`section_theory`.
  42
  43 .. _subsection_tui_creating:
  44
  45 Création de cas de calcul TUI ADAO et exemples
  46 ----------------------------------------------
  47
  48 .. _subsection_tui_example:
  49
  50 Un exemple simple de création d'un cas de calcul TUI ADAO
  51 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  52
  53 Pour introduire l'interface TUI, on commence par un exemple simple mais complet
  54 de cas de calcul ADAO. Toutes les données sont explicitement définies dans le
  55 corps du script pour faciliter la lecture. L'ensemble des commandes est le
  56 suivant::
  57
  58     from numpy import array, matrix
  59     from adao import adaoBuilder
  60     case = adaoBuilder.New()
  61     case.set( 'AlgorithmParameters', Algorithm='3DVAR' )
  62     case.set( 'Background',          Vector=[0, 1, 2] )
  63     case.set( 'BackgroundError',     ScalarSparseMatrix=1.0 )
  64     case.set( 'Observation',         Vector=array([0.5, 1.5, 2.5]) )
  65     case.set( 'ObservationError',    DiagonalSparseMatrix='1 1 1' )
  66     case.set( 'ObservationOperator', Matrix='1 0 0;0 2 0;0 0 3' )
  67     case.set( 'Observer',            Variable="Analysis", Template="ValuePrinter" )
  68     case.execute()
  69
  70 Le résultat de l'exécution de ces commandes dans SALOME (que ce soit par la
  71 commande "*shell*" de SALOME, dans la console Python de l'interface, ou par le
  72 menu d'exécution d'un script) est le suivant::
  73
  74     Analysis [ 0.25000264  0.79999797  0.94999939]
  75
  76 Création détaillée d'un cas de calcul TUI ADAO
  77 ++++++++++++++++++++++++++++++++++++++++++++++
  78
  79 On décrit ici plus en détail les différentes étapes de création d'un cas de
  80 calcul TUI ADAO. Les commandes elles-mêmes sont détaillées juste après dans
  81 l':ref:`subsection_tui_commands`.
  82
  83 La création et l'initialisation d'une étude se font par les commandes suivantes,
  84 le nom ``case`` de l'objet du cas de calcul TUI ADAO étant quelconque, au choix
  85 de l'utilisateur::
  86
  87     from numpy import array, matrix
  88     from adao import adaoBuilder
  89     case = adaoBuilder.New()
  90
  91 Il est recommandé d'importer par principe le module ``numpy`` ou ses
  92 constructeurs particuliers comme celui d'``array``, pour faciliter ensuite son
  93 usage dans les commandes elle-mêmes.
  94
  95 Ensuite, le cas doit être construit par une préparation et un enregistrement des
  96 données définissant l'étude. L'ordre de ces commande n'a pas d'importance, il
  97 suffit que les concepts requis par l'algorithme utilisé soient présentes. On se
  98 reportera à :ref:`section_reference` et à ses sous-parties pour avoir le détail
  99 des commandes par algorithme. Ici, on définit successivement l'algorithme
 100 d'assimilation de données ou d'optimisation choisi et ses paramètres, puis
 101 l'ébauche :math:`\mathbf{x}^b` (nommée ``Background``) et sa covariance
 102 d'erreurs :math:`\mathbf{B}` (nommée ``BackgroundError``), et enfin
 103 l'observation :math:`\mathbf{y}^o` (nommée ``Observation``) et sa covariance
 104 d'erreurs :math:`\mathbf{R}` (nommée ``ObservationError``)::
 105
 106     case.set( 'AlgorithmParameters', Algorithm='3DVAR' )
 107     #
 108     case.set( 'Background',          Vector=[0, 1, 2] )
 109     case.set( 'BackgroundError',     ScalarSparseMatrix=1.0 )
 110     #
 111     case.set( 'Observation',         Vector=array([0.5, 1.5, 2.5]) )
 112     case.set( 'ObservationError',    DiagonalSparseMatrix='1 1 1' )
 113
 114 On remarque que l'on peut donner, en entrée des quantités vectorielles ou
 115 matricielles, des objets de type ``str``, ``list`` ou ``tuple`` de Python, ou de
 116 type ``array`` ou ``matrix`` de Numpy. Dans ces deux derniers cas, il faut
 117 simplement importer le module Numpy avant.
 118
 119 On doit ensuite définir les opérateurs :math:`H` d'observation et éventuellement
 120 :math:`M` d'évolution. Dans tous les cas, linéaire ou non-linéaire, on peut les
 121 définir comme des fonctions. Dans le cas simple d'un opérateur linéaire, on peut
 122 aussi le définir à l'aide de la matrice qui correspond à l'opérateur linéaire.
 123 Dans le cas présent le plus simple d'opérateur linéaire, on utilise la syntaxe
 124 suivante pour un opérateur de :math:`\mathbf{R}^3` sur lui-même::
 125
 126     case.set( 'ObservationOperator', Matrix = "1 0 0;0 2 0;0 0 3")
 127
 128 Dans le cas beaucoup plus courant d'un opérateur non-linéaire de
 129 :math:`\mathbf{R}^n` dans  :math:`\mathbf{R}^p`, il doit être préalablement
 130 disponible sous la forme d'une fonction Python, connue dans l'espace de nommage
 131 courant, qui prend en entrée un vecteur ``numpy`` (ou une liste ordonnée) de
 132 taille :math:`n` et qui restitue en sortie un vecteur ``numpy`` de taille
 133 :math:`p`. Lorsque seul l'opérateur non-linéaire est défini par l'argument
 134 "*OneFunction*", son adjoint est directement établi de manière numérique et il
 135 est paramétrable par l'argument "*Parameters*". L'exemple suivant montre une
 136 fonction ``simulation`` (qui réalise ici le même opérateur linéaire que
 137 ci-dessus) et l'enregistre dans le cas ADAO::
 138
 139     import numpy
 140     def simulation(x):
 141         "Fonction de simulation H pour effectuer Y=H(X)"
 142         __x = numpy.matrix(numpy.ravel(numpy.matrix(x))).T
 143         __H = numpy.matrix("1 0 0;0 2 0;0 0 3")
 144         return __H * __x
 145     #
 146     case.set( 'ObservationOperator',
 147         OneFunction = simulation,
 148         Parameters  = {"DifferentialIncrement":0.01},
 149         )
 150
 151 Pour connaître les résultats intermédiaire ou finaux du calcul du cas, on peut
 152 ajouter des "*observer*", qui permettent d'associer l'exécution d'un script à
 153 une variable intermédiaire ou finale du calcul. On se reportera à la description
 154 de la manière d':ref:`section_advanced_observer`, et à la :ref:`section_reference`
 155 pour savoir quelles sont les quantités observables. Cette association
 156 d'"*observer*" avec une quantité existante se fait de manière similaire à la
 157 définition des données du calcul::
 158
 159     case.set( 'Observer', Variable="Analysis", Template="ValuePrinter" )
 160
 161 Enfin, lorsque toutes les informations requises sont disponibles dans le cas
 162 ``case`` de calcul ADAO, on peut en demander l'exécution de manière très
 163 simple dans l'environnement de l'interpréteur Python::
 164
 165     case.execute()
 166
 167 Au final, on obtient le script très compact proposé précédemment dans
 168 :ref:`subsection_tui_example`.
 169
 170 Fournir des données ou informations de calcul plus complexes
 171 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 172
 173 Une telle interface s'écrivant en Python, il est possible d'utiliser toute la
 174 puissance du langage pour entrer des données plus complexes qu'une déclaration
 175 explicite.
 176
 177 L'enregistrement des données d'entrées supporte différents types de variables,
 178 mais surtout, ces entrées peuvent recevoir des variables courantes disponibles
 179 dans l'espace de nommage du script. Il est donc aisé d'utiliser des variables
 180 calculées préalablement ou obtenues par l'import de scripts "utilisateur". Si
 181 par exemple les observations sont disponibles sous la forme d'une liste dans un
 182 fichier Python externe nommé ``observations.py`` sous le nom ``table``, il
 183 suffit de réaliser les opérations suivantes pour enregistrer les observations
 184 dans le cas de calcul TUI ADAO::
 185
 186     from observations import table
 187     case.set( 'Observation', Vector=table )
 188
 189 La première ligne importe la variable ``table`` depuis le fichier externe, et la
 190 seconde enregistre directement cette table comme la donnée "*Observation*".
 191
 192 La simplicité de cet enregistrement montre bien la facilité d'obtenir les
 193 données de calcul depuis des sources externes, fichiers ou flux informatiques
 194 atteignables en Python. Comme d'habitude, il est recommandé à l'utilisateur de
 195 vérifier ses données avant de les enregistrer dans le cas de calcul TUI ADAO
 196 pour éviter les erreurs compliquées à corriger.
 197
 198 Obtenir et utiliser les résultats de calcul de manière plus riche
 199 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 200
 201 De la même manière, il est possible d'obtenir et traiter les résultats de calcul
 202 de manière plus riche, pour enchaîner sur des post-traitements après le calcul
 203 en TUI.
 204
 205 Les variables de résultats de calcul, ou les variables internes issues de
 206 l'optimisation ou de l'assimilation de données, sont disponibles à travers la
 207 méthode ``get`` du cas de calcul TUI ADAO, qui renvoie un objet de type liste de
 208 la variable demandée. On se reportera aux :ref:`section_ref_output_variables`
 209 pour une description détaillée sur ce sujet.
 210
 211 A titre d'exemple, on donne quelques lignes de script qui permettent d'obtenir
 212 le nombre d'itérations de l'optimisation et la valeur optimale ainsi que sa
 213 taille::
 214
 215     print("")
 216     print("    Nombre d'iterations : %i"%len(case.get("CostFunctionJ")))
 217     Xa = case.get("Analysis")
 218     print("    Analyse optimale    : %s"%(Xa[-1],))
 219     print("    Taille de l'analyse : %i"%len(Xa[-1]))
 220     print("")
 221
 222 Ces lignes peuvent être très simplement additionnées à l'exemple initial de cas
 223 de calcul TUI ADAO proposé dans :ref:`subsection_tui_example`.
 224
 225 De même que pour l'entrée des données, la simplicité de récupération des
 226 résultats permet d'envisager aisément des post-traitements enchaînés dans
 227 SALOME, pour utiliser par exemple de la visualisation avec MatPlotLib ou PARAVIS
 228 [PARAVIS]_, de l'adaptation de maillage avec HOMARD [HOMARD]_, ou pour d'autres
 229 calculs.
 230
 231 .. _subsection_tui_commands:
 232
 233 Ensemble des commandes disponibles en interface textuelle TUI
 234 -------------------------------------------------------------
 235
 236 Dans l'interface TUI du module ADAO, on suit les conventions et recommandations
 237 courantes en Python pour la distinction entre ce qui est public, et ce qui est
 238 privé ou réservé car relevant des détails d'implémentation. De manière pratique,
 239 tout nom d'objet ou de fonction commençant par au moins un signe "_" est privé
 240 au sens courant de programmation ("*private*"). Néanmoins, l'absence d'un tel
 241 signe au début d'un nom ne le désigne pas comme public. De manière générale, en
 242 Python, et contrairement à d'autres langages, on peut accéder aux objets ou aux
 243 fonction privés. Cela peut parfois être utile, mais un tel usage dans vos codes
 244 conduira à des plantages sans avertissement lors de futures versions. Il est
 245 donc fortement recommandé de ne pas le faire.
 246
 247 Pour clarifier et faciliter l'utilisation du module pour du script, **cette
 248 section définit donc l'interface de programmation (API) textuelle publique pour
 249 l'utilisateur (TUI) de manière complète et limitative**. L'usage en script
 250 d'objets ou fonctions ADAO autres que ceux qui sont définis ici est fortement
 251 déconseillé, car cela conduira vraisemblablement à des plantages sans
 252 avertissement lors de futures versions.
 253
 254 Syntaxes d'appel équivalentes pour les commandes TUI
 255 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 256
 257 La définition des données lors de la création de cas de calcul TUI ADAO supporte
 258 **deux syntaxes entièrement équivalentes**. On peut :
 259
 260 - soit utiliser la commande ``set`` et comme premier argument le concept
 261   ``XXXXX`` sur lequel appliquer la commande dont les arguments suivent,
 262 - soit utiliser la commande ``setXXXXX`` contenant les arguments de la commande
 263   à appliquer.
 264
 265 Pour illustrer cette équivalence, on prend l'exemple des deux commandes
 266 suivantes qui conduisent au même résultat::
 267
 268     case.set( 'Background', Vector=[0, 1, 2] )
 269
 270 et::
 271
 272     case.setBackground( Vector=[0, 1, 2] )
 273
 274 Le choix de l'une ou l'autre des syntaxes est librement laissé à l'utilisateur,
 275 selon son contexte d'usage. Dans la suite, par souci de clarté, on définit les
 276 commandes selon la seconde syntaxe.
 277
 278 Création d'un cas de calcul en interface textuelle TUI
 279 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 280
 281 La création et l'initialisation d'un cas de calcul en interface textuelle TUI se
 282 font en important le module d'interface "*adaoBuilder*" et en invoquant sa
 283 méthode "*New()*" comme illustré dans les quelques lignes suivantes (le nom
 284 ``case`` de l'objet étant quelconque, au choix de l'utilisateur)::
 285
 286     from numpy import array, matrix
 287     from adao import adaoBuilder
 288     case = adaoBuilder.New()
 289
 290 Il est recommandé par principe de toujours importer le module ``numpy`` (ou ses
 291 constructeurs particuliers, comme celui d'``array``) pour faciliter ensuite son
 292 usage dans les commandes elles-mêmes.
 293
 294 Définir les données de calcul
 295 +++++++++++++++++++++++++++++
 296
 297 Les commandes qui suivent permettent de définir les données d'un cas de calcul
 298 TUI ADAO. Le pseudo-type des arguments est similaire et compatible avec ceux des
 299 entrées en interface GUI, décrits dans la section des
 300 :ref:`section_reference_entry` et en particulier par la
 301 :ref:`section_ref_entry_types`. La vérification de l'adéquation des grandeurs se
 302 fait soit lors de leur définition, soit lors de l'exécution.
 303
 304 Dans chaque commande, le mot-clé booléen "*Stored*" permet d'indiquer si l'on
 305 veut éventuellement la stocker la grandeur définie, pour en disposer en cours de
 306 calcul ou en sortie. Le choix par défaut est de ne pas stocker, et il est
 307 recommandé de conserver cette valeur par défaut. En effet, pour un cas de calcul
 308 TUI, on dispose déjà souvent des grandeurs données en entrées qui sont présentes
 309 dans l'espace de nommage courant du cas.
 310
 311 Les commandes disponibles sont les suivantes :
 312
 313 .. index:: single: setBackground
 314
 315 **setBackground** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*)
 316     Cette commande permet de définir l'ébauche :math:`\mathbf{x}^b`. Selon les
 317     algorithmes, on peut la définir comme un vecteur simple par "*Vector*", ou
 318     comme une liste de vecteurs par "*VectorSerie*". Si on la définit par un
 319     script dans "*Script*", le vecteur est de type "*Vector*" (par défaut) ou
 320     "*VectorSerie*" selon que l'une de ces variables est placée à "*True*". Si
 321     on utilise un fichier de données par "*DataFile*" (en sélectionnant, en
 322     colonne par défaut ou en ligne selon "*ColMajor*", toutes les variables par
 323     défaut ou celles de la liste "*ColNames*"), le vecteur est de type
 324     "*Vector*".
 325
 326 .. index:: single: setBackgroundError
 327
 328 **setBackgroundError** (*Matrix, ScalarSparseMatrix, DiagonalSparseMatrix, Script, Stored*)
 329     Cette commande permet de définir la matrice :math:`\mathbf{B}` de
 330     covariance des erreurs d'ébauche. La matrice peut être définie de manière
 331     complète par le mot-clé "*Matrix*", ou de manière parcimonieuse, comme une
 332     matrice diagonale dont on donne la variance unique sur la diagonale par
 333     "*ScalarSparseMatrix*", ou comme une matrice diagonale dont on donne le
 334     vecteur des variances situé sur la diagonale par "*DiagonalSparseMatrix*".
 335     Si on la définit par un script dans "*Script*", la matrice est de type
 336     "*Matrix*" (par défaut), "*ScalarSparseMatrix*" ou "*DiagonalSparseMatrix*"
 337     selon que l'une de ces variables est placée à "*True*".
 338
 339 .. index:: single: setCheckingPoint
 340
 341 **setCheckingPoint** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*)
 342     Cette commande permet de définir un point courant :math:`\mathbf{x}`
 343     utilisé pour un algorithme de vérification. Selon les algorithmes, on peut
 344     le définir comme un vecteur simple par "*Vector*", ou comme une liste de
 345     vecteurs par "*VectorSerie*". Si on le définit par un script dans
 346     "*Script*", le vecteur est de type "*Vector*" (par défaut) ou
 347     "*VectorSerie*" selon que l'une de ces variables est placée à "*True*". Si
 348     on utilise un fichier de données par "*DataFile*" (en sélectionnant, en
 349     colonne par défaut ou en ligne selon "*ColMajor*", toutes les variables par
 350     défaut ou celles de la liste "*ColNames*"), le vecteur est de type
 351     "*Vector*".
 352
 353 .. index:: single: setControlModel
 354
 355 **setControlModel** (*Matrix, OneFunction, ThreeFunctions, Parameters, Script, ExtraArgs, Stored*)
 356     Cette commande permet de définir l'opérateur de contrôle :math:`O`, qui
 357     décrit un contrôle d'entrée linéaire externe de l'opérateur d'évolution ou
 358     d'observation. On se reportera :ref:`section_ref_operator_control`. Sa
 359     valeur est définie comme un objet de type fonction ou de type "*Matrix*".
 360     Dans le cas d'une fonction, différentes formes fonctionnelles peuvent être
 361     utilisées, comme décrit dans la section
 362     :ref:`section_ref_operator_requirements`, et entrées par les mots-clés
 363     "*OneFunction*" ou "*ThreeFunctions*". Dans le cas d'une définition par
 364     "*Script*", l'opérateur est de type "*Matrix*", "*OneFunction*" ou
 365     "*ThreeFunctions*" selon que l'une de ces variables est placée à "*True*".
 366     Les paramètres de contrôle de l'approximation numérique de l'opérateur
 367     adjoint, dans le cas "*OneFunction*", peuvent être renseignés par un
 368     dictionnaire à travers le mot-clé "*Parameters*". Les entrées potentielles
 369     de ce dictionnaire de paramètres sont "*DifferentialIncrement*",
 370     "*CenteredFiniteDifference*" (similaires à celles de l'interface graphique).
 371
 372 .. index:: single: setControlInput
 373
 374 **setControlInput** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*)
 375     Cette commande permet de définir le vecteur de contrôle :math:`\mathbf{u}`.
 376     Selon les algorithmes, on peut le définir comme un vecteur simple par
 377     "*Vector*", ou comme une liste de vecteurs par "*VectorSerie*". Si on le
 378     définit par un script dans "*Script*", le vecteur est de type "*Vector*"
 379     (par défaut) ou "*VectorSerie*" selon que l'une de ces variables est placée
 380     à "*True*". Si on utilise un fichier de données par "*DataFile*" (en
 381     sélectionnant, en colonne par défaut ou en ligne selon "*ColMajor*", toutes
 382     les variables par défaut ou celles de la liste "*ColNames*"), le vecteur
 383     est de type "*Vector*".
 384
 385 .. index:: single: setEvolutionError
 386
 387 **setEvolutionError** (*Matrix, ScalarSparseMatrix, DiagonalSparseMatrix, Script, Stored*)
 388     Cette commande permet de définir la matrice :math:`\mathbf{Q}` de
 389     covariance des erreurs d'évolution. La matrice peut être définie de manière
 390     complète par le mot-clé "*Matrix*", ou de manière parcimonieuse, comme une
 391     matrice diagonale dont on donne la variance unique sur la diagonale par
 392     "*ScalarSparseMatrix*", ou comme une matrice diagonale dont on donne le
 393     vecteur des variances situé sur la diagonale par "*DiagonalSparseMatrix*".
 394     Si on la définit par un script dans "*Script*", la matrice est de type
 395     "*Matrix*" (par défaut), "*ScalarSparseMatrix*" ou "*DiagonalSparseMatrix*"
 396     selon que l'une de ces variables est placée à "*True*".
 397
 398 .. index:: single: setEvolutionModel
 399
 400 **setEvolutionModel** (*Matrix, OneFunction, ThreeFunctions, Parameters, Script, ExtraArgs, Stored*)
 401     Cette commande permet de définir l'opérateur d'evolution :math:`M`, qui
 402     décrit un pas élémentaire d'évolution. Sa valeur est définie comme un objet
 403     de type fonction ou de type "*Matrix*". Dans le cas d'une fonction,
 404     différentes formes fonctionnelles peuvent être utilisées, comme décrit dans
 405     la section :ref:`section_ref_operator_requirements`, et entrées par les
 406     mots-clés "*OneFunction*" ou "*ThreeFunctions*". Dans le cas d'une
 407     définition par "*Script*", l'opérateur est de type "*Matrix*",
 408     "*OneFunction*" ou "*ThreeFunctions*" selon que l'une de ces variables est
 409     placée à "*True*". Les paramètres de contrôle de l'approximation numérique
 410     de l'opérateur adjoint, dans le cas "*OneFunction*", peuvent être renseignés
 411     par un dictionnaire dans "*Parameters*". Les entrées potentielles de ce
 412     dictionnaire de paramètres sont "*DifferentialIncrement*",
 413     "*CenteredFiniteDifference*", "*EnableMultiProcessing*",
 414     "*NumberOfProcesses*" (similaires à celles de l'interface graphique).
 415
 416 .. index:: single: setObservation
 417
 418 **setObservation** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*)
 419     Cette commande permet de définir le vecteur d'observation
 420     :math:`\mathbf{y}^o`. Selon les algorithmes, on peut le définir comme un
 421     vecteur simple par "*Vector*", ou comme une liste de vecteurs par
 422     "*VectorSerie*". Si on le définit par un script dans "*Script*", le vecteur
 423     est de type "*Vector*" (par défaut) ou "*VectorSerie*" selon que l'une de
 424     ces variables est placée à "*True*". Si on utilise un fichier de données
 425     par "*DataFile*" (en sélectionnant, en colonne par défaut ou en ligne selon
 426     "*ColMajor*", toutes les variables par défaut ou celles de la liste
 427     "*ColNames*"), le vecteur est de type "*Vector*".
 428
 429 .. index:: single: setObservationError
 430
 431 **setObservationError** (*Matrix, ScalarSparseMatrix, DiagonalSparseMatrix, Script, Stored*)
 432     Cette commande permet de définir la matrice :math:`\mathbf{R}` de
 433     covariance des erreurs d'observation. La matrice peut être définie de
 434     manière complète par le mot-clé "*Matrix*", ou de manière parcimonieuse,
 435     comme une matrice diagonale dont on donne la variance unique sur la
 436     diagonale par "*ScalarSparseMatrix*", ou comme une matrice diagonale dont on
 437     donne le vecteur des variances situé sur la diagonale par
 438     "*DiagonalSparseMatrix*". Si on la définit par un script dans "*Script*", la
 439     matrice est de type "*Matrix*" (par défaut), "*ScalarSparseMatrix*" ou
 440     "*DiagonalSparseMatrix*" selon que l'une de ces variables est placée à
 441     "*True*".
 442
 443 .. index:: single: setObservationOperator
 444
 445 **setObservationOperator** (*Matrix, OneFunction, ThreeFunctions, AppliedInXb, Parameters, Script, ExtraArgs, Stored*)
 446     Cette commande permet de définir l'opérateur d'observation :math:`H`, qui
 447     transforme les paramètres d'entrée :math:`\mathbf{x}` en résultats
 448     :math:`\mathbf{y}` qui sont à comparer aux observations
 449     :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de type fonction
 450     ou de type "*Matrix*". Dans le cas d'une fonction, différentes formes
 451     fonctionnelles peuvent être utilisées, comme décrit dans la section
 452     :ref:`section_ref_operator_requirements`, et entrées par les mots-clés
 453     "*OneFunction*" ou "*ThreeFunctions*". Dans le cas d'une définition par
 454     "*Script*", l'opérateur est de type "*Matrix*", "*OneFunction*" ou
 455     "*ThreeFunctions*" selon que l'une de ces variables est placée à "*True*".
 456     Dans le cas où l'opérateur :math:`H` évalué en :math:`\mathbf{x}^b` est
 457     disponible, il peut être donné en utilisant "*AppliedInXb*" et sera
 458     considéré comme un vecteur. Les paramètres de contrôle de l'approximation
 459     numérique de l'opérateur adjoint, dans le cas "*OneFunction*", peuvent être
 460     renseignés par un dictionnaire dans "*Parameters*". Les entrées potentielles
 461     de ce dictionnaire de paramètres sont "*DifferentialIncrement*",
 462     "*CenteredFiniteDifference*", "*EnableMultiProcessing*",
 463     "*NumberOfProcesses*" (similaires à celles de l'interface graphique).
 464
 465 .. index:: single: set
 466
 467 **set** (*Concept,...*)
 468     Cette commande permet de disposer d'une syntaxe équivalente pour toutes les
 469     commandes de ce paragraphe. Son premier argument est le nom du concept à
 470     définir (par exemple "*Background*" ou "*ObservationOperator*"), sur lequel
 471     s'applique ensuite les arguments qui suivent, qui sont les mêmes que dans
 472     les commandes individuelles précédentes. Lors de l'usage de cette commande,
 473     il est indispensable de nommer les arguments (par exemple "*Vector=...*").
 474
 475 Paramétrer le calcul, les sorties, etc.
 476 +++++++++++++++++++++++++++++++++++++++
 477
 478 .. index:: single: setAlgorithmParameters
 479
 480 **setAlgorithmParameters** (*Algorithm, Parameters, Script*)
 481     Cette commande permet de choisir l'algorithme de calcul ou de vérification
 482     par l'argument "*Algorithm*" sous la forme d'un nom d'algorithme (on se
 483     reportera utilement aux listes des :ref:`section_reference_assimilation` et
 484     des :ref:`section_reference_checking`), et de définir les paramètres de
 485     calcul par l'argument "*Parameters*". Dans le cas d'une définition par
 486     "*Script*", le fichier indiqué doit contenir les deux variables
 487     "*Algorithm*" et "*Parameters*" (ou "*AlgorithmParameters*" de manière
 488     équivalente).
 489
 490 .. index:: single: setName
 491
 492 **setName** (*String*)
 493     Cette commande permet de donner un titre court au cas de calcul.
 494
 495 .. index:: single: setDirectory
 496
 497 **setDirectory** (*String*)
 498     Cette commande permet d'indiquer le répertoire courant d'exécution.
 499
 500 .. index:: single: setDebug
 501
 502 **setDebug** ()
 503     Cette commande permet d'activer le mode d'information détaillé lors de
 504     l'exécution.
 505
 506 .. index:: single: setNoDebug
 507
 508 **setNoDebug** ()
 509     Cette commande permet de désactiver le mode d'information détaillé lors de
 510     l'exécution.
 511
 512 .. index:: single: setObserver
 513
 514 **setObserver** (*Variable, Template, String, Script, Info*)
 515     Cette commande permet de définir un *observer* sur une variable courante ou
 516     finale du calcul. On se reportera à la description des
 517     :ref:`section_ref_observers_requirements` pour avoir leur liste et leur
 518     format, et à la :ref:`section_reference` pour savoir quelles sont les
 519     quantités observables. On définit comme un "*String*" le corps de
 520     l'*observer*, en utilisant une chaîne de caractères incluant si nécessaire
 521     des sauts de lignes. On recommande d'utiliser les patrons disponibles par
 522     l'argument "*Template*". Dans le cas d'une définition par "*Script*", le
 523     fichier indiqué doit contenir uniquement le corps de la fonction, comme
 524     décrit dans les :ref:`section_ref_observers_requirements`. La variable
 525     "*Info*" contient une chaîne de caractère d'information ou une chaine vide.
 526
 527 Effectuer le calcul
 528 +++++++++++++++++++
 529
 530 .. index:: single: execute
 531 .. index:: single: Executor
 532 .. index:: single: SaveCaseInFile
 533
 534 **execute** (*Executor, SaveCaseInFile*)
 535     Cette commande lance le calcul complet dans l'environnement d'exécution
 536     choisi par le mot-clé *Executor*. Cet environnement peut être celui de
 537     l'interpréteur Python, sans interaction avec YACS (demandé par la valeur
 538     "*Python*"), ou celui de YACS (demandé par la valeur "*YACS*" [YACS]_). Si
 539     un fichier est indiqué dans le mot-clé *SaveCaseInFile*, il sera utilisé
 540     pour enregistrer la version associée du fichier de commande pour
 541     l'environnement d'exécution requis. Lors de l'exécution, les sorties
 542     courantes (standard et d'erreur) sont celles de l'environnement choisi. On
 543     dispose si nécessaire (ou si possible) du parallélisme interne des
 544     algorithmes dans ADAO, du parallélisme de YACS, et du parallélisme interne
 545     du ou des codes de simulation utilisés.
 546
 547 Obtenir séparément les résultats de calcul
 548 ++++++++++++++++++++++++++++++++++++++++++
 549
 550 .. index:: single: get
 551
 552 **get** (*Concept*)
 553     Cette commande permet d'extraire explicitement les variables disponibles en
 554     sortie du cas de calcul TUI ADAO pour les utiliser dans la suite du
 555     scripting, par exemple en visualisation. Elle a pour argument le nom d'un
 556     variable dans "*Concept*", et renvoie en retour la grandeur sous la forme
 557     d'une liste (même s'il n'y en a qu'un exemplaire) de cette variable de
 558     base. Pour connaître la liste des variables et les utiliser, on se
 559     reportera à l':ref:`subsection_r_o_v_Inventaire`, et plus généralement à la
 560     fois aux :ref:`section_ref_output_variables` et aux documentations
 561     individuelles des algorithmes.
 562
 563 Enregistrer, charger ou convertir les commandes de cas de calcul
 564 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 565
 566 L'enregistrement ou le chargement d'un cas de calcul concernent les quantités
 567 et les actions qui lui sont liées par les commandes précédentes, à l'exclusion
 568 d'opérations externes au cas (comme par exemple le post-processing qui peut
 569 être développé après le cas de calcul). Les commandes enregistrées ou chargées
 570 restent néanmoins parfaitement compatibles avec ces opérations en Python
 571 externes au cas.
 572
 573 .. index:: single: load
 574 .. index:: single: FileName
 575 .. index:: single: Content
 576 .. index:: single: Object
 577 .. index:: single: Formater
 578
 579 **load** (*FileName, Content, Object, Formater*)
 580     Cette commande permet de lire ou charger un cas d'étude, à partir d'un
 581     fichier "*FileName*" ou d'un contenu en mémoire par "*Content*" ou
 582     "*Object*". Le mot-clé "*Formater*" peut désigner le format "*TUI*" pour
 583     les commandes du type interface de programmation textuelle (défaut), et le
 584     format "*COM*" pour les commandes du type COMM provenant de l'interface
 585     ADAO de type EFICAS.
 586
 587 .. index:: single: dump
 588
 589 **dump** (*FileName, Formater*)
 590     Cette commande permet d'enregistrer, dans un fichier "*FileName*", les
 591     commandes du cas d'étude en cours. Le mot-clé "*Formater*" peut désigner
 592     les formats "*TUI*" pour les commandes du type interface de programmation
 593     textuelle (défaut), et "*YACS*" pour les commandes du type YACS.
 594
 595 .. index:: single: convert
 596 .. index:: single: FileNameFrom
 597 .. index:: single: ContentFrom
 598 .. index:: single: ObjectFrom
 599 .. index:: single: FormaterFrom
 600 .. index:: single: FileNameTo
 601 .. index:: single: FormaterTo
 602
 603 **convert** (*FileNameFrom, ContentFrom, ObjectFrom, FormaterFrom, FileNameTo, FormaterTo*)
 604     Cette commande permet de convertir directement d'un format reconnu à un
 605     autre les commandes établissant le cas de calcul en cours. Certains
 606     formats ne sont disponibles qu'en entrée ou qu'en sortie.
 607
 608 .. _subsection_tui_advanced:
 609
 610 Exemples plus avancés de cas de calcul TUI ADAO
 611 -----------------------------------------------
 612
 613 On propose ici des exemples plus complets de cas de calcul TUI ADAO, en donnant
 614 l'objectif de l'exemple et un jeu de commandes qui permet de parvenir à cet
 615 objectif.
 616
 617 Exploitation indépendante des résultats d'un cas de calcul
 618 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 619
 620 L'objectif est d'effectuer en TUI la mise en données d'un cas de calcul ADAO,
 621 son exécution, puis la récupération des résultats pour ensuite enchaîner sur une
 622 exploitation indépendante de ces résultats (cette dernière n'étant pas décrite
 623 ici, puisque dépendante de l'utilisateur).
 624
 625 Les hypothèses du cas utilisateur sont les suivantes. On suppose :
 626
 627 #. que l'on veut recaler 3 paramètres ``alpha``, ``beta`` et ``gamma`` dans un domaine borné,
 628 #. que l'on dispose d'observations nommées ``observations``,
 629 #. que l'utilisateur dispose en Python d'une fonction de simulation physique appelée ``simulation``, préalablement (bien) testée, qui transforme les 3 paramètres en résultats similaires aux observations,
 630 #. que l'exploitation indépendante, que l'utilisateur veut faire, est représentée ici par l'affichage simple de l'état initial, de l'état optimal, de la simulation en ce point, des états intermédiaires et du nombre d'itérations d'optimisation.
 631
 632 Pour effectuer de manière simple cet essai de cas de calcul TUI, on se donne par
 633 exemple les entrées suivantes, parfaitement arbitraires, en construisant les
 634 observations par simulation pour se placer dans un cas d'expériences jumelles::
 635
 636     #
 637     # Construction artificielle d'un exemple de données utilisateur
 638     # -------------------------------------------------------------
 639     alpha = 5.
 640     beta = 7
 641     gamma = 9.0
 642     #
 643     alphamin, alphamax = 0., 10.
 644     betamin,  betamax  = 3, 13
 645     gammamin, gammamax = 1.5, 15.5
 646     #
 647     def simulation(x):
 648         "Fonction de simulation H pour effectuer Y=H(X)"
 649         import numpy
 650         __x = numpy.matrix(numpy.ravel(numpy.matrix(x))).T
 651         __H = numpy.matrix("1 0 0;0 2 0;0 0 3; 1 2 3")
 652         return __H * __x
 653     #
 654     # Observations obtenues par simulation
 655     # ------------------------------------
 656     observations = simulation((2, 3, 4))
 657
 658 Le jeu de commandes que l'on peut utiliser est le suivant::
 659
 660     import numpy
 661     from adao import adaoBuilder
 662     #
 663     # Mise en forme des entrées
 664     # -------------------------
 665     Xb = (alpha, beta, gamma)
 666     Bounds = (
 667         (alphamin, alphamax),
 668         (betamin,  betamax ),
 669         (gammamin, gammamax))
 670     #
 671     # TUI ADAO
 672     # --------
 673     case = adaoBuilder.New()
 674     case.set(
 675         'AlgorithmParameters',
 676         Algorithm = '3DVAR',
 677         Parameters = {
 678             "Bounds":Bounds,
 679             "MaximumNumberOfSteps":100,
 680             "StoreSupplementaryCalculations":[
 681                 "CostFunctionJ",
 682                 "CurrentState",
 683                 "SimulatedObservationAtOptimum",
 684                 ],
 685             }
 686         )
 687     case.set( 'Background', Vector = numpy.array(Xb), Stored = True )
 688     case.set( 'Observation', Vector = numpy.array(observations) )
 689     case.set( 'BackgroundError', ScalarSparseMatrix = 1.0e10 )
 690     case.set( 'ObservationError', ScalarSparseMatrix = 1.0 )
 691     case.set(
 692         'ObservationOperator',
 693         OneFunction = simulation,
 694         Parameters  = {"DifferentialIncrement":0.0001},
 695         )
 696     case.set( 'Observer', Variable="CurrentState", Template="ValuePrinter" )
 697     case.execute()
 698     #
 699     # Exploitation indépendante
 700     # -------------------------
 701     Xbackground   = case.get("Background")
 702     Xoptimum      = case.get("Analysis")[-1]
 703     FX_at_optimum = case.get("SimulatedObservationAtOptimum")[-1]
 704     J_values      = case.get("CostFunctionJ")[:]
 705     print("")
 706     print("Nombre d'itérations internes...: %i"%len(J_values))
 707     print("Etat initial...................: %s"%(numpy.ravel(Xbackground),))
 708     print("Etat optimal...................: %s"%(numpy.ravel(Xoptimum),))
 709     print("Simulation à l'état optimal....: %s"%(numpy.ravel(FX_at_optimum),))
 710     print("")
 711
 712 L'exécution de jeu de commandes donne le résultat suivant::
 713
 714     CurrentState [ 5.  7.  9.]
 715     CurrentState [ 0.   3.   1.5]
 716     CurrentState [ 1.40006418  3.86705307  3.7061137 ]
 717     CurrentState [ 1.42580231  3.68474804  3.81008738]
 718     CurrentState [ 1.60220353  3.0677108   4.06146069]
 719     CurrentState [ 1.72517855  3.03296953  4.04915706]
 720     CurrentState [ 2.00010755  3.          4.00055409]
 721     CurrentState [ 1.99995528  3.          3.99996367]
 722     CurrentState [ 2.00000007  3.          4.00000011]
 723     CurrentState [ 2.  3.  4.]
 724
 725     Nombre d'itérations internes...: 10
 726     Etat initial...................: [ 5.  7.  9.]
 727     Etat optimal...................: [ 2.  3.  4.]
 728     Simulation à l'état optimal....: [  2.   6.  12.  20.]
 729
 730 Comme il se doit en expériences jumelles, avec une confiance majoritairement
 731 placée dans les observations, on constate que l'on retrouve bien les paramètres
 732 qui ont servi à construire artificiellement les observations.
 733
 734 .. Réconciliation de courbes à l'aide de MedCoupling
 735 .. +++++++++++++++++++++++++++++++++++++++++++++++++
 736
 737 .. Utilisation de fonctions de surveillance de type "observer"
 738 .. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 739
 740 .. Equivalences entre l'interface graphique (GUI) et l'interface textuelle (TUI)
 741 .. -----------------------------------------------------------------------------
 742
 743 .. [HOMARD] Pour de plus amples informations sur HOMARD, voir le *module HOMARD* et son aide intégrée disponible dans le menu principal *Aide* de l'environnement SALOME.
 744
 745 .. [PARAVIS] Pour de plus amples informations sur PARAVIS, voir le *module PARAVIS* et son aide intégrée disponible dans le menu principal *Aide* de l'environnement SALOME.
 746
 747 .. [YACS] Pour de plus amples informations sur YACS, voir le *module YACS* et son aide intégrée disponible dans le menu principal *Aide* de l'environnement SALOME.