doc/fr/reference.rst

   1 ..
   2    Copyright (C) 2008-2021 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 textuelle (TUI), graphique
  32 (GUI) ou à travers des scripts. Les deux premières sections communes présentent
  33 les :ref:`section_reference_entry` et les
  34 :ref:`section_reference_special_entry`. Ensuite, on décrit successivement les
  35 :ref:`section_reference_assimilation` et les :ref:`section_reference_checking`.
  36
  37 Chaque commande ou mot-clé à définir par la TUI ou la GUI a des propriétés
  38 particulières. La première propriété est d'être *requise*, *optionnelle* ou
  39 simplement utile, décrivant un type d'entrée. La seconde propriété est d'être
  40 une variable "ouverte" avec un type fixé mais avec n'importe quelle valeur
  41 autorisée par le type, ou une variable "fermée", limitée à des valeurs
  42 spécifiées. L'éditeur graphique GUI intégré disposant de capacités intrinsèques
  43 de validation, les propriétés des commandes ou mots-clés données à l'aide de
  44 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 choix algorithmiques pour utiliser des méthodes
  87 d'assimilation de données, des méthodes d'optimisation ou des méthodes avec
  88 réduction, disponibles dans ADAO, détaillant leurs caractéristiques
  89 d'utilisation et leurs options.
  90
  91 Des exemples sur l'usage de ces commandes sont disponibles dans la section
  92 :ref:`section_tutorials_in_salome`, dans la section
  93 :ref:`section_tutorials_in_python` et dans les fichiers d'exemple installés
  94 avec ADAO. Les notations mathématiques utilisées sont expliquées dans la
  95 section :ref:`section_theory`.
  96
  97 .. toctree::
  98    :maxdepth: 1
  99
 100    ref_algorithm_3DVAR
 101    ref_algorithm_4DVAR
 102    ref_algorithm_Blue
 103    ref_algorithm_DerivativeFreeOptimization
 104    ref_algorithm_DifferentialEvolution
 105    ref_algorithm_EnsembleBlue
 106    ref_algorithm_EnsembleKalmanFilter
 107    ref_algorithm_ExtendedBlue
 108    ref_algorithm_ExtendedKalmanFilter
 109    ref_algorithm_KalmanFilter
 110    ref_algorithm_LinearLeastSquares
 111    ref_algorithm_NonLinearLeastSquares
 112    ref_algorithm_ParticleSwarmOptimization
 113    ref_algorithm_QuantileRegression
 114    ref_algorithm_TabuSearch
 115    ref_algorithm_UnscentedKalmanFilter
 116    ref_assimilation_keywords
 117
 118 .. _section_reference_checking:
 119
 120 ================================================================================
 121 **[DocR]** Cas de vérification
 122 ================================================================================
 123
 124 Cette section décrit les algorithmes de vérification disponibles dans ADAO,
 125 détaillant leurs caractéristiques d'utilisation et leurs options.
 126
 127 Des exemples sur l'usage de ces commandes sont disponibles dans la section
 128 :ref:`section_tutorials_in_salome`, dans la section
 129 :ref:`section_tutorials_in_python` et dans les fichiers d'exemple installés
 130 avec ADAO. Les notations mathématiques utilisées sont expliquées dans la
 131 section :ref:`section_theory`.
 132
 133 .. toctree::
 134    :maxdepth: 1
 135
 136    ref_algorithm_AdjointTest
 137    ref_algorithm_FunctionTest
 138    ref_algorithm_GradientTest
 139    ref_algorithm_InputValuesTest
 140    ref_algorithm_LinearityTest
 141    ref_algorithm_LocalSensitivityTest
 142    ref_algorithm_ObserverTest
 143    ref_algorithm_ParallelFunctionTest
 144    ref_algorithm_SamplingTest
 145    ref_algorithm_TangentTest
 146    ref_checking_keywords