doc/fr/reference.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 .. _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. Les deux premières sections communes présentent les
  33 :ref:`section_reference_entry` et les :ref:`section_reference_special_entry`.
  34 Ensuite, on décrit successivement les :ref:`section_reference_assimilation` et
  35 les :ref:`section_reference_checking`.
  36
  37 Chaque commande ou mot-clé à définir par l'interface graphique (GUI) a des
  38 propriétés particulières. La première propriété est d'être *requise*,
  39 *optionnelle* ou simplement utile, décrivant un type d'entrée. La seconde
  40 propriété est d'être une variable "ouverte" avec un type fixé mais avec
  41 n'importe quelle valeur autorisée par le type, ou une variable "fermée", limitée
  42 à des valeurs spécifiées. L'éditeur graphique intégré disposant de capacités
  43 intrinsèques de validation, les propriétés des commandes ou mots-clés données à
  44 l'aide de l'interface graphique sont automatiquement correctes.
  45
  46 .. _section_reference_entry:
  47
  48 ========================================================================================
  49 **[DocR]** Entrées et sorties générales
  50 ========================================================================================
  51
  52 Cette section décrit de manière générale les différentes possibilités de types
  53 d'entrées et de variables de sortie que l'on peut utiliser. Les notations
  54 mathématiques utilisées sont expliquées dans la section :ref:`section_theory`.
  55
  56 .. toctree::
  57    :maxdepth: 1
  58
  59    ref_entry_types
  60    ref_options_AlgorithmParameters
  61    ref_output_variables
  62
  63 .. _section_reference_special_entry:
  64
  65 ========================================================================================
  66 **[DocR]** Entrées spéciales : fonctions, matrices, "*observer*"
  67 ========================================================================================
  68
  69 Cette section décrit les entrées spéciales, comme les formes fonctionnelles ou
  70 matricielles, que l'on peut utiliser. Les notations mathématiques utilisées
  71 sont expliquées dans la section :ref:`section_theory`.
  72
  73 .. toctree::
  74    :maxdepth: 1
  75
  76    ref_operator_requirements
  77    ref_covariance_requirements
  78    ref_observers_requirements
  79
  80 .. _section_reference_assimilation:
  81
  82 ============================================================================================
  83 **[DocR]** Cas d'assimilation de données ou d'optimisation
  84 ============================================================================================
  85
  86 Cette section décrit les algorithmes d'assimilation de données ou d'optimisation
  87 disponibles dans ADAO, détaillant leurs caractéristiques d'utilisation et leurs
  88 options.
  89
  90 Des exemples sur l'usage de ces commandes sont disponibles dans la section
  91 :ref:`section_examples` et dans les fichiers d'exemple installés avec le module
  92 ADAO. Les notations mathématiques utilisées sont expliquées dans la section
  93 :ref:`section_theory`.
  94
  95 .. toctree::
  96    :maxdepth: 1
  97
  98    ref_assimilation_keywords
  99    ref_algorithm_3DVAR
 100    ref_algorithm_4DVAR
 101    ref_algorithm_Blue
 102    ref_algorithm_DerivativeFreeOptimization
 103    ref_algorithm_EnsembleBlue
 104    ref_algorithm_EnsembleKalmanFilter
 105    ref_algorithm_ExtendedBlue
 106    ref_algorithm_ExtendedKalmanFilter
 107    ref_algorithm_KalmanFilter
 108    ref_algorithm_LinearLeastSquares
 109    ref_algorithm_NonLinearLeastSquares
 110    ref_algorithm_ParticleSwarmOptimization
 111    ref_algorithm_QuantileRegression
 112    ref_algorithm_UnscentedKalmanFilter
 113
 114 .. _section_reference_checking:
 115
 116 ================================================================================
 117 **[DocR]** Cas de vérification
 118 ================================================================================
 119
 120 Cette section décrit les algorithmes de vérification disponibles dans ADAO,
 121 détaillant leurs caractéristiques d'utilisation et leurs options.
 122
 123 Des exemples sur l'usage de ces commandes sont disponibles dans la section
 124 :ref:`section_examples` et dans les fichiers d'exemple installés avec le module
 125 ADAO. Les notations mathématiques utilisées sont expliquées dans la section
 126 :ref:`section_theory`.
 127
 128 .. toctree::
 129    :maxdepth: 1
 130
 131    ref_checking_keywords
 132    ref_algorithm_AdjointTest
 133    ref_algorithm_FunctionTest
 134    ref_algorithm_GradientTest
 135    ref_algorithm_LinearityTest
 136    ref_algorithm_ObserverTest
 137    ref_algorithm_SamplingTest
 138    ref_algorithm_TangentTest