doc/fr/ref_checking_keywords.rst

   1 ..
   2    Copyright (C) 2008-2018 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: CHECKING_STUDY
  25 .. _section_ref_checking_keywords:
  26
  27 Liste des commandes et mots-clés pour un cas de vérification
  28 ------------------------------------------------------------
  29
  30 .. index:: single: Algorithm
  31 .. index:: single: AlgorithmParameters
  32 .. index:: single: Debug
  33 .. index:: single: Observer
  34 .. index:: single: Observers
  35 .. index:: single: Observer Template
  36 .. index:: single: StudyName
  37 .. index:: single: StudyRepertory
  38 .. index:: single: UserDataInit
  39
  40 Ce jeu de commandes est lié à la description d'un cas de vérification, qui est
  41 une procédure pour vérifier les propriétés d'une information requise, utilisée
  42 ailleurs par un cas de calcul. Les termes sont classés par ordre alphabétique,
  43 sauf le premier, qui décrit le choix entre le calcul ou la vérification.
  44
  45 Les différentes commandes sont les suivantes:
  46
  47   **CHECKING_STUDY**
  48     *Commande obligatoire*. C'est la commande générale qui décrit le cas de
  49     vérification. Elle contient hiérarchiquement toutes les autres commandes.
  50
  51   AlgorithmParameters
  52     *Commande obligatoire*. Elle définit l'algorithme de test choisi par le
  53     mot-clé "*Algorithm*", et ses éventuels paramètres optionnels. Les choix
  54     d'algorithmes sont disponibles à travers l'interface graphique. Il existe
  55     par exemple le "FunctionTest", le "GradientTest"... Chaque algorithme est
  56     défini, plus loin, par une sous-section spécifique. De manière facultative,
  57     la commande permet aussi d'ajouter des paramètres pour contrôler
  58     l'algorithme. Leurs valeurs sont définies explicitement ou dans un objet de
  59     type "*Dict*". On se reportera à la
  60     :ref:`section_ref_options_Algorithm_Parameters` pour l'usage détaillé de
  61     cette partie de la commande.
  62
  63   .. include:: snippets/CheckingPoint.rst
  64
  65   .. include:: snippets/BackgroundError.rst
  66
  67   Debug
  68     *Commande optionnelle*. Elle définit le niveau de sorties et d'informations
  69     intermédiaires de débogage. Les choix sont limités entre 0 (pour False) et
  70     1 (pour True).
  71
  72   .. include:: snippets/Observation.rst
  73
  74   .. include:: snippets/ObservationError.rst
  75
  76   .. include:: snippets/ObservationOperator.rst
  77
  78   Observers
  79     *Commande optionnelle*. Elle permet de définir des observateurs internes,
  80     qui sont des fonctions liées à une variable particulière, qui sont exécutées
  81     chaque fois que cette variable est modifiée. C'est une manière pratique de
  82     suivre des variables d'intérêt durant le processus d'assimilation de données
  83     ou d'optimisation, en l'affichant ou en la traçant, etc. Des exemples
  84     courants (squelettes) sont fournis pour aider l'utilisateur ou pour
  85     faciliter l'élaboration d'un cas.
  86
  87   StudyName
  88     *Commande obligatoire*. C'est une chaîne de caractères quelconque pour
  89     décrire l'étude ADAO par un nom ou une déclaration.
  90
  91   StudyRepertory
  92     *Commande optionnelle*. S'il existe, ce répertoire est utilisé comme base
  93     pour les calculs, et il est utilisé pour trouver les fichiers de script,
  94     donnés par nom sans répertoire, qui peuvent être utilisés pour définir
  95     certaines variables.
  96
  97   UserDataInit
  98     *Commande optionnelle*. Elle permet d'initialiser certains paramètres ou
  99     certaines données automatiquement avant le traitement de données d'entrée
 100     pour l'assimilation de données ou l'optimisation. Pour cela, elle indique un
 101     nom de fichier de script à exécuter avant d'entrer dans l'initialisation des
 102     variables choisies.