doc/fr/reference.rst

   1 ..
   2    Copyright (C) 2008-2023 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 options de types
  53 d'entrées et de variables de sortie. Les notations mathématiques utilisées sont
  54 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 : mesures, fonctions, matrices, "*observer*", post-traitement
  67 ==========================================================================================
  68
  69 Cette section décrit les entrées spéciales, comme les formes fonctionnelles ou
  70 matricielles, et les conditions requises pour les utiliser. Les notions et
  71 notations mathématiques relatives à ces entrées sont expliquées dans la section
  72 :ref:`section_theory`.
  73
  74 .. toctree::
  75    :maxdepth: 1
  76
  77    ref_observations_requirements
  78    ref_operator_requirements
  79    ref_covariance_requirements
  80    ref_observers_requirements
  81    ref_userpostanalysis_requirements
  82
  83 .. _section_reference_assimilation:
  84
  85 ================================================================================
  86 **[DocR]** Cas d'assimilation de données ou d'optimisation
  87 ================================================================================
  88
  89 Cette section décrit les choix algorithmiques pour utiliser des méthodes
  90 d'assimilation de données, des méthodes d'optimisation ou des méthodes avec
  91 réduction, disponibles dans ADAO, en détaillant leurs caractéristiques et leurs
  92 options.
  93
  94 Des exemples sur l'usage de ces commandes sont disponibles dans la section des
  95 :ref:`section_tutorials_in_salome`, dans la section des
  96 :ref:`section_tutorials_in_python`, dans la section des
  97 :ref:`section_docu_examples`, et dans les fichiers d'exemple installés avec
  98 ADAO. Les notions et notations mathématiques utilisées sont expliquées dans la
  99 section générale donnant :ref:`section_theory`.
 100
 101 .. toctree::
 102    :maxdepth: 1
 103
 104    ref_algorithm_3DVAR
 105    ref_algorithm_4DVAR
 106    ref_algorithm_Blue
 107    ref_algorithm_DerivativeFreeOptimization
 108    ref_algorithm_DifferentialEvolution
 109    ref_algorithm_EnsembleBlue
 110    ref_algorithm_EnsembleKalmanFilter
 111    ref_algorithm_ExtendedBlue
 112    ref_algorithm_ExtendedKalmanFilter
 113    ref_algorithm_KalmanFilter
 114    ref_algorithm_LinearLeastSquares
 115    ref_algorithm_NonLinearLeastSquares
 116    ref_algorithm_ParticleSwarmOptimization
 117    ref_algorithm_QuantileRegression
 118    ref_algorithm_TabuSearch
 119    ref_algorithm_UnscentedKalmanFilter
 120    ref_assimilation_keywords
 121
 122 .. _section_reference_checking:
 123
 124 ================================================================================
 125 **[DocR]** Cas de vérification
 126 ================================================================================
 127
 128 Cette section décrit les algorithmes de vérification disponibles dans ADAO,
 129 détaillant leurs caractéristiques d'utilisation et leurs options.
 130
 131 Des exemples sur l'usage de ces commandes sont disponibles dans la section des
 132 :ref:`section_tutorials_in_salome`, dans la section des
 133 :ref:`section_tutorials_in_python`, dans la section des
 134 :ref:`section_docu_examples`, et dans les fichiers d'exemple installés avec
 135 ADAO. Les notions et notations mathématiques utilisées sont expliquées dans la
 136 section générale donnant :ref:`section_theory`.
 137
 138 .. toctree::
 139    :maxdepth: 1
 140
 141    ref_algorithm_AdjointTest
 142    ref_algorithm_ControledFunctionTest
 143    ref_algorithm_FunctionTest
 144    ref_algorithm_GradientTest
 145    ref_algorithm_InputValuesTest
 146    ref_algorithm_LinearityTest
 147    ref_algorithm_LocalSensitivityTest
 148    ref_algorithm_ObservationSimulationComparisonTest
 149    ref_algorithm_ObserverTest
 150    ref_algorithm_ParallelFunctionTest
 151    ref_algorithm_SamplingTest
 152    ref_algorithm_TangentTest
 153    ref_checking_keywords
 154
 155 .. _section_reference_task:
 156
 157 ================================================================================
 158 **[DocR]** Cas orientés tâches ou études dédiées
 159 ================================================================================
 160
 161 Cette section décrit les algorithmes de tâches facilitant une étude dédiée
 162 disponibles dans ADAO, détaillant leurs caractéristiques d'utilisation et leurs
 163 options.
 164
 165 Ces tâches utilisent des algorithmes provenant de méthodes d'assimilation de
 166 données, de méthodes d'optimisation ou de méthodes avec réduction. On renvoie à
 167 la section générale donnant :ref:`section_theory` et à celle des
 168 :ref:`section_reference_assimilation` pour les détails algorithmiques
 169 sous-jacents.
 170
 171 .. toctree::
 172    :maxdepth: 1
 173
 174    ref_algorithm_EnsembleOfSimulationGenerationTask
 175    ref_algorithm_InterpolationByReducedModelTask
 176    ref_algorithm_MeasurementsOptimalPositioningTask
 177    ref_task_keywords