doc/fr/ref_options_AlgorithmParameters.rst

   1 ..
   2    Copyright (C) 2008-2015 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: AlgorithmParameters
  25 .. _section_ref_options_AlgorithmParameters:
  26
  27 Description des options d'un algorithme par "*AlgorithmParameters*"
  28 -------------------------------------------------------------------
  29
  30 Chaque algorithme peut être contrôlé en utilisant des options particulières,
  31 données à travers la commande optionnelle "*AlgorithmParameters*".
  32
  33 Il y a 2 méthodes pratiques pour l'utilisateur pour fournir ces options. La
  34 méthode est choisie à l'aide du mot-clé "*FROM*", inclus dans l'entrée
  35 "*AlgorithmParameters*" dans EFICAS.
  36
  37 Si une option est spécifiée par l'utilisateur pour un algorithme qui ne la
  38 supporte pas, cette option est simplement laissée inutilisée et ne bloque pas le
  39 traitement. La signification des acronymes ou des noms particuliers peut être
  40 trouvée dans l':ref:`genindex` ou dans le :ref:`section_glossary`.
  41
  42 Première méthode : utiliser une chaîne de caractères dans EFICAS
  43 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  44
  45 Pour donner les valeurs de la commande "*AlgorithmParameters*" par une chaîne de
  46 caractères, directement dans l'interface graphique EFICAS, l'utilisateur
  47 sélectionne ce type dans le mot-clé "*FROM*", comme montré dans la figure qui
  48 suit :
  49
  50   .. adao_algopar_string:
  51   .. image:: images/adao_algopar_string.png
  52     :align: center
  53     :width: 100%
  54   .. centered::
  55     **Utiliser une chaîne de caractères pour les paramètres algorithmiques**
  56
  57 Dans le champs de saisie, il faut utiliser des guillemets simples pour une
  58 définition standard de dictionnaire, comme par exemple::
  59
  60     '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
  61
  62 C'est la manière recommandée pour définir des paramètres algorithmiques.
  63
  64 Seconde méthode : utiliser un fichier de script Python externe
  65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  66
  67 Pour donner les valeurs de la commande "*AlgorithmParameters*" par un fichier de
  68 script Python externe, l'utilisateur sélectionne dans EFICAS ce type dans le
  69 mot-clé "*FROM*", comme montré dans la figure qui suit :
  70
  71   .. :adao_algopar_script
  72   .. image:: images/adao_algopar_script.png
  73     :align: center
  74     :width: 100%
  75   .. centered::
  76     **Utiliser un fichier externe pour les paramètres algorithmiques**
  77
  78 Ce fichier script Python externe doit définir alors une variable au nom imposé
  79 "*AlgorithmParameters*", à la manière de l'exemple qui suit::
  80
  81     AlgorithmParameters = {
  82         "StoreInternalVariables" : True,
  83         "MaximumNumberOfSteps" : 25,
  84         "StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
  85         }
  86
  87 Le fichier peut aussi contenir d'autres commandes Python.