doc/fr/reference.rst

   1 ..
   2    Copyright (C) 2008-2014 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 .. _section_reference:
  25
  26 ================================================================================
  27 **[DocR]** Description de référence des commandes et mots-clés ADAO
  28 ================================================================================
  29
  30 Les sections suivantes présentent la description de référence des commandes et
  31 mots-clés ADAO disponibles à travers l'interface graphique (GUI) ou à travers
  32 des scripts. Une première section commune présente de manière générale les
  33 :ref:`section_reference_entry`. Ensuite, on décrit successivement les
  34 :ref:`section_reference_assimilation` et les :ref:`section_reference_checking`.
  35
  36 Chaque commande ou mot-clé à définir par l'interface graphique (GUI) a des
  37 propriétés particulières. La première propriété est d'être *requise*,
  38 *optionnelle* ou simplement utile, décrivant un type d'entrée. La seconde
  39 propriété est d'être une variable "ouverte" avec un type fixé mais avec
  40 n'importe quelle valeur autorisée par le type, ou une variable "fermée", limitée
  41 à des valeurs spécifiées. L'éditeur graphique EFICAS disposant de capacités
  42 intrinsèques de validation, les propriétés des commandes ou mots-clés données à
  43 l'aide de l'interface graphique sont automatiquement correctes.
  44
  45 .. _section_reference_entry:
  46
  47 ========================================================================================
  48 **[DocR]** Entrées générales, fonctions et matrices
  49 ========================================================================================
  50
  51 Cette section décrit de manière générale les différents types d'entrées
  52 possibles, et les formes fonctionnelles ou matricielles que l'on peut utiliser.
  53 Les notations mathématiques utilisées sont expliquées dans la section
  54 :ref:`section_theory`.
  55
  56 .. toctree::
  57    :maxdepth: 1
  58
  59    ref_entry_types
  60    ref_options_AlgorithmParameters
  61    ref_operator_requirements
  62    ref_covariance_requirements
  63
  64 .. _section_reference_assimilation:
  65
  66 ============================================================================================
  67 **[DocR]** Cas d'assimilation de données ou d'optimisation
  68 ============================================================================================
  69
  70 Cette section décrit les algorithmes d'assimilation de données ou d'optimisation
  71 disponibles dans ADAO, détaillant leurs caractéristiques d'utilisation et leurs
  72 options.
  73
  74 Des exemples sur l'usage de ces commandes sont disponibles dans la section
  75 :ref:`section_examples` et dans les fichiers d'exemple installés avec le module
  76 ADAO. Les notations mathématiques utilisées sont expliquées dans la section
  77 :ref:`section_theory`.
  78
  79 .. toctree::
  80    :maxdepth: 1
  81
  82    ref_assimilation_keywords
  83    ref_algorithm_3DVAR
  84    ref_algorithm_LinearLeastSquares
  85    ref_algorithm_NonLinearLeastSquares
  86    ref_algorithm_Blue
  87    ref_algorithm_ExtendedBlue
  88    ref_algorithm_EnsembleBlue
  89    ref_algorithm_KalmanFilter
  90    ref_algorithm_ExtendedKalmanFilter
  91    ref_algorithm_UnscentedKalmanFilter
  92    ref_algorithm_ParticleSwarmOptimization
  93    ref_algorithm_QuantileRegression
  94
  95 .. _section_reference_checking:
  96
  97 ================================================================================
  98 **[DocR]** Cas de vérification
  99 ================================================================================
 100
 101 Cette section décrit les algorithmes de vérification disponibles dans ADAO,
 102 détaillant leurs caractéristiques d'utilisation et leurs options.
 103
 104 Des exemples sur l'usage de ces commandes sont disponibles dans la section
 105 :ref:`section_examples` et dans les fichiers d'exemple installés avec le module
 106 ADAO. Les notations mathématiques utilisées sont expliquées dans la section
 107 :ref:`section_theory`.
 108
 109 .. toctree::
 110    :maxdepth: 1
 111
 112    ref_checking_keywords
 113    ref_algorithm_AdjointTest
 114    ref_algorithm_FunctionTest
 115    ref_algorithm_GradientTest
 116    ref_algorithm_LinearityTest
 117    ref_algorithm_ObserverTest
 118    ref_algorithm_TangentTest
 119    ref_algorithm_SamplingTest