Updating documentation by review and snippets (4)

diff --git a/doc/fr/index.rst b/doc/fr/index.rst
index 1ded4db3e0fee65a8ad8ec35e39a511c3f824d48..d8b33db340150cd1ba9a0f7da61a4f6a4255da20 100644 (file)
--- a/doc/fr/index.rst
+++ b/doc/fr/index.rst
@@ -32,10 +32,7 @@ Documentation ADAO
    :alt: Logo ADAO
 
 **Le module ADAO fournit des fonctionnalités d'assimilation de données et
-d'optimisation** dans un contexte Python [Python]_ ou SALOME [Salome]_. Il est
-basé sur l'utilisation d'autres modules, à savoir YACS et EFICAS s'ils sont
-disponibles, et sur l'utilisation d'une bibliothèque et d'outils génériques
-sous-jacents d'assimilation de données.
+d'optimisation** dans un contexte Python [Python]_ ou SALOME [Salome]_.
 
 En bref, l'assimilation de données est un cadre méthodologique pour calculer
 l'estimation optimale de la valeur réelle (inaccessible) de l'état d'un
@@ -43,29 +40,33 @@ système, éventuellement au cours du temps. Il utilise des informations
 provenant de mesures expérimentales, ou observations, et de modèles numériques
 *a priori*, y compris des informations sur leurs erreurs. Certaines des
 méthodes incluses dans ce cadre sont également connues sous les noms
-d'*estimation des paramètres*, de *problèmes inverses*, d'*estimation
-bayésienne*, d'*interpolation optimale*, etc. De plus amples détails peuvent
-être trouvés dans la partie proposant :ref:`section_theory`.
+d'*estimation de paramètres*, de *problèmes inverses*, d'*estimation
+bayésienne*, d'*interpolation optimale*, de *reconstruction de champs*, etc. De
+plus amples détails peuvent être trouvés dans la partie proposant
+:ref:`section_theory`.
 
 La documentation de ce module est divisée en plusieurs grandes catégories,
-relatives à la documentation théorique (indiquée dans le titre par **[DocT]**),
-à la documentation utilisateur (indiquée dans le titre par **[DocU]**), et à la
-documentation de référence (indiquée dans le titre par **[DocR]**).
+relatives à la documentation théorique (indiquée dans le titre de section par
+**[DocT]**), à la documentation utilisateur (indiquée dans le titre de section
+par **[DocU]**), et à la documentation de référence (indiquée dans le titre de
+section par **[DocR]**).
 
 La première partie est l':ref:`section_intro`. La seconde partie présente
 :ref:`section_theory`, et à leurs concepts, et la partie suivante décrit la
-:ref:`section_methodology`. Pour un utilisateur courant, la quatrième partie
-explique comment :ref:`section_using`, et la cinquième partie présente des
-exemples d'utilisation sous la forme de :ref:`section_examples`. Les
-utilisateurs intéressés par un accès rapide au module peuvent s'arrêter avant la
-lecture de la suite, mais un usage utile du module nécessite de lire et de
-revenir régulièrement aux quatrième et septième parties. La sixième partie
-indique les :ref:`section_advanced`, avec l'obtention de renseignements
-supplémentaires ou l'usage par scripts d'exécution sans interface utilisateur
-graphique (GUI). La septième partie détaille la :ref:`section_reference`, avec
-quatre sous-parties principales qui suivent, la dernière décrivant une
-:ref:`section_tui` du module. Enfin, pour respecter les exigences de licence du
-module, n'oubliez pas de lire la partie :ref:`section_license`.
+:ref:`section_methodology`. Pour un utilisateur courant, les parties suivantes
+présentent des exemples didactiques d'utilisation sous la forme de
+:ref:`section_tutorials_in_salome` ou de :ref:`section_tutorials_in_python`,
+puis indique les :ref:`section_advanced`, avec l'obtention de renseignements
+supplémentaires ou l'usage par scripts de commandes hors interface de contrôle
+graphique. Les utilisateurs intéressés par un accès rapide au module peuvent
+s'arrêter avant la lecture de la suite, mais un usage utile du module nécessite
+de lire et de revenir régulièrement à ces parties. Les parties qui suivent
+expliquent comment utiliser une :ref:`section_gui_in_salome` ou une
+:ref:`section_tui`. La dernière grande partie détaille la
+:ref:`section_reference`, avec trois sous-parties essentielles qui la composent
+et qui décrivent les commandes et des options d'algorithmes. Enfin, pour
+respecter les exigences de licence du module, n'oubliez pas de lire la partie
+:ref:`section_license`.
 
 Dans cette documentation, on utilise les notations standards de l'algèbre
 linéaire, de l'assimilation de données (comme décrit dans [Ide97]_) et de
@@ -75,8 +76,7 @@ normalement, ou avec une notation condensée, consistant à utiliser un espace
 pour séparer les valeurs, et un "``;``" pour séparer les lignes de la matrice,
 de façon continue sur une ligne.
 
-Table des matières
-------------------
+**Table des matières**
 
 .. toctree::
    :maxdepth: 2
@@ -84,17 +84,17 @@ Table des matières
    intro
    theory
    methodology
-   using
-   examples
+   tutorials_in_salome
+   tutorials_in_python
    advanced
-   reference
+   gui_in_salome
    tui
+   reference
    license
    glossary
    bibliography
 
-Index et tables
----------------
+**Index et tables**
 
 * :ref:`genindex`
 * :ref:`search`

diff --git a/doc/fr/ref_algorithm_3DVAR.rst b/doc/fr/ref_algorithm_3DVAR.rst
index b6f54434c75fecdc23612178fd12e1713074cfa3..b3c11e2f0e866323e2d7755287a587e39e72ba30 100644 (file)
--- a/doc/fr/ref_algorithm_3DVAR.rst
+++ b/doc/fr/ref_algorithm_3DVAR.rst
@@ -27,8 +27,8 @@
 Algorithme de calcul "*3DVAR*"
 ------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation d'état par minimisation variationnelle de
 la fonctionnelle :math:`J` d'écart classique en assimilation de données
@@ -39,162 +39,170 @@ statique:
 qui est usuellement désignée comme la fonctionnelle "*3D-VAR*" (voir par exemple
 [Talagrand97]_).
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/BoundsWithNone.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/CostDecrementTolerance.rst
 
-  Minimizer
-    .. index:: single: Minimizer
+.. include:: snippets/GradientNormTolerance.rst
 
-    Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
-    défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
-    linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
-    (minimisation non linéaire sous contraintes), "CG" (minimisation non
-    linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
-    contraintes), "NCG" (minimisation de type gradient conjugué de Newton). Il
-    est fortement conseillé de conserver la valeur par défaut.
+.. include:: snippets/MaximumNumberOfSteps.rst
 
-    Exemple :
-    ``{"Minimizer":"LBFGSB"}``
+Minimizer
+  .. index:: single: Minimizer
 
-  .. include:: snippets/BoundsWithNone.rst
+  Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
+  défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
+  linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
+  (minimisation non linéaire sous contraintes), "CG" (minimisation non
+  linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
+  contraintes), "NCG" (minimisation de type gradient conjugué de Newton). Il
+  est fortement conseillé de conserver la valeur par défaut.
 
-  .. include:: snippets/MaximumNumberOfSteps.rst
+  Exemple :
+  ``{"Minimizer":"LBFGSB"}``
 
-  .. include:: snippets/CostDecrementTolerance.rst
+.. include:: snippets/NumberOfSamplesForQuantiles.rst
 
-  .. include:: snippets/ProjectedGradientTolerance.rst
+.. include:: snippets/ProjectedGradientTolerance.rst
 
-  .. include:: snippets/GradientNormTolerance.rst
+.. include:: snippets/Quantiles.rst
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/SetSeed.rst
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["APosterioriCorrelations",
-    "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "CostFunctionJb",
-    "CostFunctionJo", "CostFunctionJAtCurrentOptimum",
-    "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum",
-    "CurrentOptimum", "CurrentState", "IndexOfOptimum", "Innovation",
-    "InnovationAtCurrentState", "MahalanobisConsistency", "OMA", "OMB",
-    "SigmaObs2", "SimulatedObservationAtBackground",
-    "SimulatedObservationAtCurrentOptimum",
-    "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum",
-    "SimulationQuantiles"].
+.. include:: snippets/SimulationForQuantiles.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/Quantiles.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "APosterioriCorrelations",
+  "APosterioriCovariance",
+  "APosterioriStandardDeviations",
+  "APosterioriVariances",
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
+  "CurrentState",
+  "IndexOfOptimum",
+  "Innovation",
+  "InnovationAtCurrentState",
+  "JacobianMatrixAtBackground",
+  "JacobianMatrixAtOptimum",
+  "KalmanGainAtOptimum",
+  "MahalanobisConsistency",
+  "OMA",
+  "OMB",
+  "SigmaObs2",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  "SimulationQuantiles",
+  ].
 
-  .. include:: snippets/SetSeed.rst
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
-  .. include:: snippets/NumberOfSamplesForQuantiles.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-  .. include:: snippets/SimulationForQuantiles.rst
+.. include:: snippets/Analysis.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. include:: snippets/CostFunctionJ.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/CostFunctionJb.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/Analysis.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/APosterioriCorrelations.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/APosterioriCovariance.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/APosterioriStandardDeviations.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriVariances.rst
 
-  .. include:: snippets/APosterioriCorrelations.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/APosterioriCovariance.rst
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
 
-  .. include:: snippets/APosterioriStandardDeviations.rst
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
 
-  .. include:: snippets/APosterioriVariances.rst
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
+.. include:: snippets/IndexOfOptimum.rst
 
-  .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/CurrentOptimum.rst
+.. include:: snippets/InnovationAtCurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. include:: snippets/JacobianMatrixAtBackground.rst
 
-  .. include:: snippets/IndexOfOptimum.rst
+.. include:: snippets/JacobianMatrixAtOptimum.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/KalmanGainAtOptimum.rst
 
-  .. include:: snippets/InnovationAtCurrentState.rst
+.. include:: snippets/MahalanobisConsistency.rst
 
-  .. include:: snippets/MahalanobisConsistency.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/OMB.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/SigmaObs2.rst
 
-  .. include:: snippets/SigmaObs2.rst
+.. include:: snippets/SimulatedObservationAtBackground.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. include:: snippets/SimulationQuantiles.rst
 
-  .. include:: snippets/SimulationQuantiles.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Voir aussi
-++++++++++
+- :ref:`section_ref_algorithm_Blue`
+- :ref:`section_ref_algorithm_ExtendedBlue`
+- :ref:`section_ref_algorithm_LinearityTest`
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_Blue`
-  - :ref:`section_ref_algorithm_ExtendedBlue`
-  - :ref:`section_ref_algorithm_LinearityTest`
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-Références bibliographiques :
-  - [Byrd95]_
-  - [Morales11]_
-  - [Talagrand97]_
-  - [Zhu97]_
+- [Byrd95]_
+- [Morales11]_
+- [Talagrand97]_
+- [Zhu97]_

diff --git a/doc/fr/ref_algorithm_4DVAR.rst b/doc/fr/ref_algorithm_4DVAR.rst
index 78bb520c9caf4b7a726b3bf8e847171638aad1ec..0550c94eb0c35d8022b43ad7f75149935afed08b 100644 (file)
--- a/doc/fr/ref_algorithm_4DVAR.rst
+++ b/doc/fr/ref_algorithm_4DVAR.rst
@@ -27,13 +27,11 @@
 Algorithme de calcul "*4DVAR*"
 ------------------------------
 
-.. warning::
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo00.rst
 
-  dans sa présente version, cet algorithme est expérimental, et reste donc
-  susceptible de changements dans les prochaines versions.
-
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de l'état d'un système dynamique, par une
 méthode de minimisation variationnelle de la fonctionnelle :math:`J` d'écart
@@ -48,124 +46,116 @@ algorithmes de filtrage de Kalman et en particulier
 l':ref:`section_ref_algorithm_ExtendedKalmanFilter` ou
 l':ref:`section_ref_algorithm_UnscentedKalmanFilter`.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
-
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
-
-  .. include:: snippets/Background.rst
-
-  .. include:: snippets/BackgroundError.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-  .. include:: snippets/EvolutionError.rst
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/EvolutionModel.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/EvolutionError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/EvolutionModel.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. include:: snippets/Observation.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/ObservationError.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/ObservationOperator.rst
 
-  Minimizer
-    .. index:: single: Minimizer
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-    Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
-    défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
-    linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
-    (minimisation non linéaire sous contraintes), "CG" (minimisation non
-    linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
-    contraintes), "NCG" (minimisation de type gradient conjugué de Newton). Il
-    est fortement conseillé de conserver la valeur par défaut.
+Minimizer
+  .. index:: single: Minimizer
 
-    Exemple :
-    ``{"Minimizer":"LBFGSB"}``
+  Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
+  défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
+  linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
+  (minimisation non linéaire sous contraintes), "CG" (minimisation non
+  linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
+  contraintes), "NCG" (minimisation de type gradient conjugué de Newton). Il
+  est fortement conseillé de conserver la valeur par défaut.
 
-  .. include:: snippets/BoundsWithNone.rst
+  Exemple :
+  ``{"Minimizer":"LBFGSB"}``
 
-  .. include:: snippets/ConstrainedBy.rst
+.. include:: snippets/BoundsWithNone.rst
 
-  .. include:: snippets/MaximumNumberOfSteps.rst
+.. include:: snippets/ConstrainedBy.rst
 
-  .. include:: snippets/CostDecrementTolerance.rst
+.. include:: snippets/MaximumNumberOfSteps.rst
 
-  .. include:: snippets/EstimationOf.rst
+.. include:: snippets/CostDecrementTolerance.rst
 
-  .. include:: snippets/ProjectedGradientTolerance.rst
+.. include:: snippets/EstimationOf.rst
 
-  .. include:: snippets/GradientNormTolerance.rst
+.. include:: snippets/ProjectedGradientTolerance.rst
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/GradientNormTolerance.rst
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
-    "CostFunctionJb", "CostFunctionJo", "CostFunctionJAtCurrentOptimum",
-    "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum",
-    "CurrentOptimum", "CurrentState", "IndexOfOptimum"].
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJb",
+  "CostFunctionJo",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
+  "CurrentState",
+  "IndexOfOptimum",
+  ].
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+  Exemple : ``{"StoreSupplementaryCalculations":["BMA", "CurrentState"]}``
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
+.. include:: snippets/CurrentOptimum.rst
 
-  .. include:: snippets/CurrentOptimum.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. include:: snippets/IndexOfOptimum.rst
 
-  .. include:: snippets/IndexOfOptimum.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Voir aussi
-++++++++++
+- :ref:`section_ref_algorithm_3DVAR`
+- :ref:`section_ref_algorithm_KalmanFilter`
+- :ref:`section_ref_algorithm_ExtendedKalmanFilter`
+- :ref:`section_ref_algorithm_EnsembleKalmanFilter`
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_3DVAR`
-  - :ref:`section_ref_algorithm_KalmanFilter`
-  - :ref:`section_ref_algorithm_ExtendedKalmanFilter`
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-Références bibliographiques :
-  - [Byrd95]_
-  - [Morales11]_
-  - [Talagrand97]_
-  - [Zhu97]_
+- [Byrd95]_
+- [Morales11]_
+- [Talagrand97]_
+- [Zhu97]_

diff --git a/doc/fr/ref_algorithm_AdjointTest.rst b/doc/fr/ref_algorithm_AdjointTest.rst
index c188e6654646ff4f48724fca5cd7e0e613876dfa..b3af821afc1f94819474d917d9147cdb87b86040 100644 (file)
--- a/doc/fr/ref_algorithm_AdjointTest.rst
+++ b/doc/fr/ref_algorithm_AdjointTest.rst
@@ -27,8 +27,8 @@
 Algorithme de vérification "*AdjointTest*"
 ------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme permet de vérifier la qualité de l'opérateur adjoint, en
 calculant un résidu dont les propriétés théoriques sont connues.
@@ -40,75 +40,60 @@ On observe le résidu suivant, qui est la différence de deux produits scalaires
 qui doit rester constamment égal à zéro à la précision du calcul. On prend
 :math:`\mathbf{dx}_0=Normal(0,\mathbf{x})` et
 :math:`\mathbf{dx}=\alpha*\mathbf{dx}_0`. :math:`F` est le code de calcul.
-:math:`\mathbf{y}` doit être dans l'image de :math:`F`. S'il n'est pas donné, on
-prend :math:`\mathbf{y} = F(\mathbf{x})`.
+:math:`\mathbf{y}` doit être dans l'image de :math:`F`. S'il n'est pas donné,
+on prend :math:`\mathbf{y} = F(\mathbf{x})`.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/CheckingPoint.rst
 
-  .. include:: snippets/CheckingPoint.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03Chck.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_checking_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/AmplitudeOfInitialDirection.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/EpsilonMinimumExponent.rst
 
-  .. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/InitialDirection.rst
 
-  .. include:: snippets/EpsilonMinimumExponent.rst
+.. include:: snippets/SetSeed.rst
 
-  .. include:: snippets/InitialDirection.rst
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/SetSeed.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "CurrentState",
+  "Residu",
+  "SimulatedObservationAtCurrentState",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["CurrentState", "Residu",
-    "SimulatedObservationAtCurrentState"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+.. include:: snippets/Residu.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/CurrentState.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/Residu.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
-
-  .. include:: snippets/CurrentState.rst
-
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_FunctionTest`
-  - :ref:`section_ref_algorithm_LinearityTest`
-  - :ref:`section_ref_algorithm_TangentTest`
-  - :ref:`section_ref_algorithm_GradientTest`
+- :ref:`section_ref_algorithm_FunctionTest`
+- :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_TangentTest`
+- :ref:`section_ref_algorithm_GradientTest`
+- :ref:`section_ref_algorithm_LocalSensitivityTest`

diff --git a/doc/fr/ref_algorithm_Blue.rst b/doc/fr/ref_algorithm_Blue.rst
index 1547bc8bcffece43570747e8bd3f2fe3e0def8a3..342838c9a311bef5a13c4b51a493d8afcfd70582 100644 (file)
--- a/doc/fr/ref_algorithm_Blue.rst
+++ b/doc/fr/ref_algorithm_Blue.rst
@@ -27,8 +27,8 @@
 Algorithme de calcul "*Blue*"
 -----------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de type BLUE (Best Linear Unbiased
 Estimator) de l'état d'un système. De manière précise, c'est un estimateur
@@ -44,115 +44,131 @@ En cas de non-linéarité, même peu marquée, on lui préférera aisément
 l':ref:`section_ref_algorithm_ExtendedBlue` ou
 l':ref:`section_ref_algorithm_3DVAR`.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/NumberOfSamplesForQuantiles.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/Quantiles.rst
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/SetSeed.rst
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["APosterioriCorrelations",
-    "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState",
-    "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", "Innovation",
-    "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
-    "SimulatedObservationAtOptimum"].
+.. include:: snippets/SimulationForQuantiles.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/Quantiles.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "APosterioriCorrelations",
+  "APosterioriCovariance",
+  "APosterioriStandardDeviations",
+  "APosterioriVariances",
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
+  "CurrentState",
+  "Innovation",
+  "MahalanobisConsistency",
+  "OMA",
+  "OMB",
+  "SigmaBck2",
+  "SigmaObs2",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  "SimulationQuantiles",
+  ].
 
-  .. include:: snippets/SetSeed.rst
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
-  .. include:: snippets/NumberOfSamplesForQuantiles.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-  .. include:: snippets/SimulationForQuantiles.rst
+.. include:: snippets/Analysis.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/APosterioriCorrelations.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriCovariance.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/APosterioriStandardDeviations.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriVariances.rst
 
-  .. include:: snippets/APosterioriCorrelations.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/APosterioriCovariance.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/APosterioriStandardDeviations.rst
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
 
-  .. include:: snippets/APosterioriVariances.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/CurrentOptimum.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/MahalanobisConsistency.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/MahalanobisConsistency.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/SigmaBck2.rst
+.. include:: snippets/OMB.rst
 
-  .. include:: snippets/SigmaObs2.rst
+.. include:: snippets/SigmaBck2.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
+.. include:: snippets/SigmaObs2.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. include:: snippets/SimulatedObservationAtBackground.rst
 
-  .. include:: snippets/SimulationQuantiles.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-Voir aussi
-++++++++++
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_ExtendedBlue`
-  - :ref:`section_ref_algorithm_3DVAR`
-  - :ref:`section_ref_algorithm_LinearityTest`
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-Références bibliographiques :
-  - [Bouttier99]_
+.. include:: snippets/SimulationQuantiles.rst
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
+
+- :ref:`section_ref_algorithm_ExtendedBlue`
+- :ref:`section_ref_algorithm_3DVAR`
+- :ref:`section_ref_algorithm_LinearityTest`
+
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
+
+- [Bouttier99]_

diff --git a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst
index e0e53dbf34cb4bb6b9fa35ba1e2f3c92c46dc28f..2d93d30c58a1ebfb4bae46554f9191b0a67fa460 100644 (file)
--- a/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst
+++ b/doc/fr/ref_algorithm_DerivativeFreeOptimization.rst
@@ -27,15 +27,16 @@
 Algorithme de calcul "*DerivativeFreeOptimization*"
 ---------------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation d'état d'un système par minimisation
 d'une fonctionnelle d'écart :math:`J` sans gradient. C'est une méthode qui
 n'utilise pas les dérivées de la fonctionnelle d'écart. Elle entre, par
 exemple, dans la même catégorie que
-l':ref:`section_ref_algorithm_ParticleSwarmOptimization` ou
-l':ref:`section_ref_algorithm_DifferentialEvolution`.
+l':ref:`section_ref_algorithm_ParticleSwarmOptimization`,
+l':ref:`section_ref_algorithm_DifferentialEvolution` ou
+l':ref:`section_ref_algorithm_TabuSearch`.
 
 C'est une méthode d'optimisation permettant la recherche du minimum global d'une
 fonctionnelle d'erreur :math:`J` quelconque de type :math:`L^1`, :math:`L^2` ou
@@ -43,130 +44,127 @@ fonctionnelle d'erreur :math:`J` quelconque de type :math:`L^1`, :math:`L^2` ou
 défaut est celle de moindres carrés pondérés augmentés, classiquement utilisée
 en assimilation de données.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/Minimizer_DFO.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/BoundsWithNone.rst
 
-  .. include:: snippets/Minimizer_DFO.rst
+.. include:: snippets/MaximumNumberOfSteps.rst
 
-  .. include:: snippets/BoundsWithNone.rst
+.. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
 
-  .. include:: snippets/MaximumNumberOfSteps.rst
+.. include:: snippets/StateVariationTolerance.rst
 
-  .. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
+.. include:: snippets/CostDecrementTolerance.rst
 
-  .. include:: snippets/StateVariationTolerance.rst
+.. include:: snippets/QualityCriterion.rst
 
-  .. include:: snippets/CostDecrementTolerance.rst
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/QualityCriterion.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
+  "CurrentState",
+  "IndexOfOptimum",
+  "Innovation",
+  "InnovationAtCurrentState",
+  "OMA",
+  "OMB",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
-    "CostFunctionJAtCurrentOptimum", "CostFunctionJb",
-    "CostFunctionJbAtCurrentOptimum", "CostFunctionJo",
-    "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState",
-    "IndexOfOptimum", "Innovation", "InnovationAtCurrentState", "OMA", "OMB",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentOptimum",
-    "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+.. include:: snippets/Analysis.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. include:: snippets/CostFunctionJ.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/CostFunctionJb.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
 
-  .. include:: snippets/CurrentState.rst
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
+.. include:: snippets/IndexOfOptimum.rst
 
-  .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
+.. include:: snippets/InnovationAtCurrentState.rst
 
-  .. include:: snippets/CurrentOptimum.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/IndexOfOptimum.rst
+.. include:: snippets/OMB.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/SimulatedObservationAtBackground.rst
 
-  .. include:: snippets/InnovationAtCurrentState.rst
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
+- :ref:`section_ref_algorithm_ParticleSwarmOptimization`
+- :ref:`section_ref_algorithm_DifferentialEvolution`
+- :ref:`section_ref_algorithm_TabuSearch`
 
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_ParticleSwarmOptimization`
-  - :ref:`section_ref_algorithm_DifferentialEvolution`
-
-Références bibliographiques :
-  - [Johnson08]_
-  - [Nelder65]_
-  - [Powell64]_
-  - [Powell94]_
-  - [Powell98]_
-  - [Powell04]_
-  - [Powell07]_
-  - [Powell09]_
-  - [Rowan90]_
+- [Johnson08]_
+- [Nelder65]_
+- [Powell64]_
+- [Powell94]_
+- [Powell98]_
+- [Powell04]_
+- [Powell07]_
+- [Powell09]_
+- [Rowan90]_

diff --git a/doc/fr/ref_algorithm_DifferentialEvolution.rst b/doc/fr/ref_algorithm_DifferentialEvolution.rst
index c6bca50a733f516a6d16ccf62c45adb3b92b998b..ea778cbbaacd62a633384f768e1d4786716dd4a6 100644 (file)
--- a/doc/fr/ref_algorithm_DifferentialEvolution.rst
+++ b/doc/fr/ref_algorithm_DifferentialEvolution.rst
@@ -27,20 +27,19 @@
 Algorithme de calcul "*DifferentialEvolution*"
 ----------------------------------------------
 
-.. warning::
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo00.rst
 
-  dans sa présente version, cet algorithme est expérimental, et reste donc
-  susceptible de changements dans les prochaines versions.
-
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de l'état d'un système par minimisation
 d'une fonctionnelle d'écart :math:`J` en utilisant une méthode évolutionnaire
 d'évolution différentielle. C'est une méthode qui n'utilise pas les dérivées de
 la fonctionnelle d'écart. Elle entre dans la même catégorie que
-l':ref:`section_ref_algorithm_DerivativeFreeOptimization` ou
-l':ref:`section_ref_algorithm_ParticleSwarmOptimization`.
+l':ref:`section_ref_algorithm_DerivativeFreeOptimization`,
+l':ref:`section_ref_algorithm_ParticleSwarmOptimization` ou
+l':ref:`section_ref_algorithm_TabuSearch`.
 
 C'est une méthode d'optimisation permettant la recherche du minimum global d'une
 fonctionnelle d'erreur :math:`J` quelconque de type :math:`L^1`, :math:`L^2` ou
@@ -48,128 +47,125 @@ fonctionnelle d'erreur :math:`J` quelconque de type :math:`L^1`, :math:`L^2` ou
 défaut est celle de moindres carrés pondérés augmentés, classiquement utilisée
 en assimilation de données.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
-
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
-
-  .. include:: snippets/Background.rst
-
-  .. include:: snippets/BackgroundError.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. include:: snippets/Observation.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/ObservationError.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/Minimizer_DE.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-  .. include:: snippets/BoundsWithExtremes.rst
+.. include:: snippets/Minimizer_DE.rst
 
-  .. include:: snippets/CrossOverProbability_CR.rst
+.. include:: snippets/BoundsWithExtremes.rst
 
-  .. include:: snippets/MaximumNumberOfSteps.rst
+.. include:: snippets/CrossOverProbability_CR.rst
 
-  .. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
+.. include:: snippets/MaximumNumberOfSteps.rst
 
-  .. include:: snippets/MutationDifferentialWeight_F.rst
+.. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
 
-  .. include:: snippets/PopulationSize.rst
+.. include:: snippets/MutationDifferentialWeight_F.rst
 
-  .. include:: snippets/QualityCriterion.rst
+.. include:: snippets/PopulationSize.rst
 
-  .. include:: snippets/SetSeed.rst
+.. include:: snippets/QualityCriterion.rst
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/SetSeed.rst
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
-    "CostFunctionJAtCurrentOptimum", "CostFunctionJb",
-    "CostFunctionJbAtCurrentOptimum", "CostFunctionJo",
-    "CostFunctionJoAtCurrentOptimum", "CurrentOptimum", "CurrentState",
-    "IndexOfOptimum", "Innovation", "InnovationAtCurrentState", "OMA", "OMB",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentOptimum",
-    "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJb",
+  "CostFunctionJbAtCurrentOptimum",
+  "CostFunctionJo",
+  "CostFunctionJoAtCurrentOptimum",
+  "CurrentOptimum",
+  "CurrentState",
+  "IndexOfOptimum",
+  "Innovation",
+  "InnovationAtCurrentState",
+  "OMA",
+  "OMB",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentOptimum",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  ].
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
+.. include:: snippets/CurrentOptimum.rst
 
-  .. include:: snippets/CurrentOptimum.rst
+.. include:: snippets/IndexOfOptimum.rst
 
-  .. include:: snippets/IndexOfOptimum.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/InnovationAtCurrentState.rst
 
-  .. include:: snippets/InnovationAtCurrentState.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/OMB.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/SimulatedObservationAtBackground.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Voir aussi
-++++++++++
+- :ref:`section_ref_algorithm_DerivativeFreeOptimization`
+- :ref:`section_ref_algorithm_ParticleSwarmOptimization`
+- :ref:`section_ref_algorithm_TabuSearch`
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_DerivativeFreeOptimization`
-  - :ref:`section_ref_algorithm_ParticleSwarmOptimization`
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-Références bibliographiques :
-  - [Chakraborty08]_
-  - [Price05]_
-  - [Storn97]_
+- [Chakraborty08]_
+- [Price05]_
+- [Storn97]_

diff --git a/doc/fr/ref_algorithm_EnsembleBlue.rst b/doc/fr/ref_algorithm_EnsembleBlue.rst
index 51bc7e173ff446b7f681eb18806db0d9aa1794bc..09322335a89c59fe133fca69a8a5f3e69126fe77 100644 (file)
--- a/doc/fr/ref_algorithm_EnsembleBlue.rst
+++ b/doc/fr/ref_algorithm_EnsembleBlue.rst
@@ -27,8 +27,8 @@
 Algorithme de calcul "*EnsembleBlue*"
 -------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de type BLUE (Best Linear Unbiased
 Estimator, qui est ici un estimateur d'Aitken) de l'état d'un système, par
@@ -40,68 +40,53 @@ doit fonctionner aussi dans les cas "faiblement" non-linéaire. On peut vérifie
 la linéarité de l'opérateur d'observation à l'aide de
 l':ref:`section_ref_algorithm_LinearityTest`.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/SetSeed.rst
 
-Les options de l'algorithme sont les suivantes:
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/SetSeed.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "CurrentState",
+  "Innovation",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["CurrentState", "Innovation"]}``
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["CurrentState", "Innovation",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
-    "SimulatedObservationAtOptimum"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["CurrentState", "Innovation"]}``
+.. include:: snippets/Analysis.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. include:: snippets/CurrentState.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/Innovation.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-  .. include:: snippets/Analysis.rst
-
-  .. include:: snippets/CurrentState.rst
-
-  .. include:: snippets/Innovation.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_Blue`
+- :ref:`section_ref_algorithm_Blue`
+- :ref:`section_ref_algorithm_EnsembleKalmanFilter`

diff --git a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst
index a18e2f8e6c5ebe4001555d762bc731b2b870a8f1..ef0c84d971b6d1fb9ea4ae33fbc18e6f8d06bf25 100644 (file)
--- a/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst
+++ b/doc/fr/ref_algorithm_EnsembleKalmanFilter.rst
@@ -27,13 +27,8 @@
 Algorithme de calcul "*EnsembleKalmanFilter*"
 ---------------------------------------------
 
-.. warning::
-
-  dans sa présente version, cet algorithme est expérimental, et reste donc
-  susceptible de changements dans les prochaines versions.
-
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de l'état d'un système dynamique par un
 filtre de Kalman d'ensemble (EnKF), permettant d'éviter de devoir calculer les
@@ -52,103 +47,93 @@ l':ref:`section_ref_algorithm_KalmanFilter`, qui sont souvent largement moins
 coûteux en évaluations sur de petits systèmes. On peut vérifier la linéarité
 des opérateurs à l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
-
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
-
-  .. include:: snippets/Background.rst
-
-  .. include:: snippets/BackgroundError.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-  .. include:: snippets/EvolutionError.rst
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/EvolutionModel.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/EvolutionError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/EvolutionModel.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. include:: snippets/Observation.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/ObservationError.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/NumberOfMembers.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-  .. include:: snippets/EstimationOf.rst
+.. include:: snippets/EstimationOf.rst
 
-  .. include:: snippets/SetSeed.rst
+.. include:: snippets/NumberOfMembers.rst
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/SetSeed.rst
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["APosterioriCorrelations",
-    "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "CostFunctionJb",
-    "CostFunctionJo", "CurrentState"].
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "APosterioriCorrelations",
+  "APosterioriCovariance",
+  "APosterioriStandardDeviations",
+  "APosterioriVariances",
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJb",
+  "CostFunctionJo",
+  "CurrentState",
+  ].
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/Analysis.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriCorrelations.rst
 
-  .. include:: snippets/APosterioriCorrelations.rst
+.. include:: snippets/APosterioriCovariance.rst
 
-  .. include:: snippets/APosterioriCovariance.rst
+.. include:: snippets/APosterioriStandardDeviations.rst
 
-  .. include:: snippets/APosterioriStandardDeviations.rst
+.. include:: snippets/APosterioriVariances.rst
 
-  .. include:: snippets/APosterioriVariances.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/Innovation.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Voir aussi
-++++++++++
+- :ref:`section_ref_algorithm_KalmanFilter`
+- :ref:`section_ref_algorithm_ExtendedKalmanFilter`
+- :ref:`section_ref_algorithm_UnscentedKalmanFilter`
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_KalmanFilter`
-  - :ref:`section_ref_algorithm_ExtendedKalmanFilter`
-  - :ref:`section_ref_algorithm_UnscentedKalmanFilter`
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-Références bibliographiques :
-  - [Evensen94]_
-  - [Burgers98]_
-  - [Evensen03]_
-  - [WikipediaEnKF]_
+- [Evensen94]_
+- [Burgers98]_
+- [Evensen03]_
+- [WikipediaEnKF]_

diff --git a/doc/fr/ref_algorithm_ExtendedBlue.rst b/doc/fr/ref_algorithm_ExtendedBlue.rst
index 81a97e11f8365884547a390e0e38c103576b815e..c68b0e6be386034a29a68ad3636c5147485e5cb0 100644 (file)
--- a/doc/fr/ref_algorithm_ExtendedBlue.rst
+++ b/doc/fr/ref_algorithm_ExtendedBlue.rst
@@ -27,8 +27,8 @@
 Algorithme de calcul "*ExtendedBlue*"
 -------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de type BLUE étendu (Best Linear Unbiased
 Estimator, étendu) de l'état d'un système.
@@ -41,112 +41,107 @@ d'observation à l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
 En non-linéaire, il se rapproche de l':ref:`section_ref_algorithm_3DVAR`, sans
 lui être entièrement équivalent.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/NumberOfSamplesForQuantiles.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/Quantiles.rst
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/SetSeed.rst
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["APosterioriCorrelations",
-    "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "OMA", "OMB", "CurrentState",
-    "CostFunctionJ", "CostFunctionJb", "CostFunctionJo", "Innovation",
-    "SigmaBck2", "SigmaObs2", "MahalanobisConsistency", "SimulationQuantiles",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
-    "SimulatedObservationAtOptimum"].
+.. include:: snippets/SimulationForQuantiles.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/Quantiles.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "APosterioriCorrelations",
+  "APosterioriCovariance",
+  "APosterioriStandardDeviations",
+  "APosterioriVariances",
+  "BMA",
+  "OMA",
+  "OMB",
+  "CurrentState",
+  "CostFunctionJ",
+  "CostFunctionJb",
+  "CostFunctionJo",
+  "Innovation",
+  "SigmaBck2",
+  "SigmaObs2",
+  "MahalanobisConsistency",
+  "SimulationQuantiles",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum", 
+  ].
 
-  .. include:: snippets/SetSeed.rst
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
-  .. include:: snippets/NumberOfSamplesForQuantiles.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-  .. include:: snippets/SimulationForQuantiles.rst
+.. include:: snippets/Analysis.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/APosterioriCorrelations.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriCovariance.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/APosterioriStandardDeviations.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriVariances.rst
 
-  .. include:: snippets/APosterioriCorrelations.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/APosterioriCovariance.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/APosterioriStandardDeviations.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/APosterioriVariances.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/MahalanobisConsistency.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/OMB.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/SigmaBck2.rst
 
-  .. include:: snippets/MahalanobisConsistency.rst
+.. include:: snippets/SigmaObs2.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/SimulatedObservationAtBackground.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-  .. include:: snippets/SigmaBck2.rst
+.. include:: snippets/SimulationQuantiles.rst
 
-  .. include:: snippets/SigmaObs2.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
-
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
-
-  .. include:: snippets/SimulationQuantiles.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_Blue`
-  - :ref:`section_ref_algorithm_3DVAR`
-  - :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_Blue`
+- :ref:`section_ref_algorithm_3DVAR`
+- :ref:`section_ref_algorithm_LinearityTest`

diff --git a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst
index 1a7b70aecd23ebd0ed7876e690969a43a5e40ea6..8696d30e733bdde8aaf56d9da597b67ed9b095dd 100644 (file)
--- a/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst
+++ b/doc/fr/ref_algorithm_ExtendedKalmanFilter.rst
@@ -27,8 +27,8 @@
 Algorithme de calcul "*ExtendedKalmanFilter*"
 ---------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de l'état d'un système dynamique par un
 filtre de Kalman étendu, utilisant un calcul non linéaire de l'état et de
@@ -41,97 +41,86 @@ largement plus adaptés aux comportements non-linéaires mais plus coûteux. On
 peut vérifier la linéarité des opérateurs à l'aide de
 l':ref:`section_ref_algorithm_LinearityTest`.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/EvolutionError.rst
 
-  .. include:: snippets/EvolutionError.rst
+.. include:: snippets/EvolutionModel.rst
 
-  .. include:: snippets/EvolutionModel.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/BoundsWithExtremes.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/ConstrainedBy.rst
 
-  .. include:: snippets/BoundsWithExtremes.rst
+.. include:: snippets/EstimationOf.rst
 
-  .. include:: snippets/ConstrainedBy.rst
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/EstimationOf.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "APosterioriCorrelations",
+  "APosterioriCovariance",
+  "APosterioriStandardDeviations",
+  "APosterioriVariances",
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJb",
+  "CostFunctionJo",
+  "CurrentState",
+  "Innovation",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["APosterioriCorrelations",
-    "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "CostFunctionJb",
-    "CostFunctionJo", "CurrentState", "Innovation"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+.. include:: snippets/Analysis.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/APosterioriCorrelations.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriCovariance.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/APosterioriStandardDeviations.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriVariances.rst
 
-  .. include:: snippets/APosterioriCorrelations.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/APosterioriCovariance.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/APosterioriStandardDeviations.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/APosterioriVariances.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-  .. include:: snippets/CostFunctionJo.rst
-
-  .. include:: snippets/CurrentState.rst
-
-  .. include:: snippets/Innovation.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_KalmanFilter`
-  - :ref:`section_ref_algorithm_EnsembleKalmanFilter`
-  - :ref:`section_ref_algorithm_UnscentedKalmanFilter`
+- :ref:`section_ref_algorithm_KalmanFilter`
+- :ref:`section_ref_algorithm_EnsembleKalmanFilter`
+- :ref:`section_ref_algorithm_UnscentedKalmanFilter`

diff --git a/doc/fr/ref_algorithm_FunctionTest.rst b/doc/fr/ref_algorithm_FunctionTest.rst
index f79e2120e3a1ec59f793fda6dbe81999d4a4c9cd..954476dbdbfcad8f6eed5e53b110a1279ec26d2c 100644 (file)
--- a/doc/fr/ref_algorithm_FunctionTest.rst
+++ b/doc/fr/ref_algorithm_FunctionTest.rst
@@ -27,8 +27,8 @@
 Algorithme de vérification "*FunctionTest*"
 -------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme permet de vérifier que l'opérateur d'observation fonctionne
 correctement et que son appel se déroule de manière compatible avec son usage
@@ -42,63 +42,50 @@ récapitulative à la fin de l'algorithme de vérification. La précision
 d'affichage est contrôlable pour permettre l'automatisation des tests
 d'opérateur.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/CheckingPoint.rst
 
-  .. include:: snippets/CheckingPoint.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03Chck.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_checking_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/NumberOfPrintedDigits.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/NumberOfRepetition.rst
 
-  .. include:: snippets/NumberOfPrintedDigits.rst
+.. include:: snippets/SetDebug.rst
 
-  .. include:: snippets/NumberOfRepetition.rst
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/SetDebug.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "CurrentState",
+  "SimulatedObservationAtCurrentState",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["CurrentState",
-    "SimulatedObservationAtCurrentState"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+*Aucune*
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/CurrentState.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_LinearityTest`

diff --git a/doc/fr/ref_algorithm_GradientTest.rst b/doc/fr/ref_algorithm_GradientTest.rst
index d5cb9ca0335d2ad7a5ecbee0a02e1fc82c2813cc..2791477cab29f3d232863f0cadf8d405212d8289 100644 (file)
--- a/doc/fr/ref_algorithm_GradientTest.rst
+++ b/doc/fr/ref_algorithm_GradientTest.rst
@@ -27,8 +27,8 @@
 Algorithme de vérification "*GradientTest*"
 -------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme permet de vérifier la qualité du gradient de l'opérateur, en
 calculant un résidu dont les propriétés théoriques sont connues. Plusieurs
@@ -87,87 +87,72 @@ On observe le résidu, qui est basé sur une approximation du gradient :
 
 qui doit rester constant jusqu'à ce que l'on atteigne la précision du calcul.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/CheckingPoint.rst
 
-  .. include:: snippets/CheckingPoint.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03Chck.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_checking_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/AmplitudeOfInitialDirection.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/EpsilonMinimumExponent.rst
 
-  .. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/InitialDirection.rst
 
-  .. include:: snippets/EpsilonMinimumExponent.rst
+.. include:: snippets/SetSeed.rst
 
-  .. include:: snippets/InitialDirection.rst
+ResiduFormula
+  .. index:: single: ResiduFormula
 
-  .. include:: snippets/SetSeed.rst
+  Cette clé indique la formule de résidu qui doit être utilisée pour le test.
+  Le choix par défaut est "Taylor", et les choix possibles sont "Taylor"
+  (résidu du développement de Taylor normalisé de l'opérateur, qui doit
+  décroître comme le carré de la perturbation), "TaylorOnNorm" (résidu du
+  développement de Taylor rapporté à la perturbation de l'opérateur, qui doit
+  rester constant) et "Norm" (résidu obtenu en prenant la norme du
+  développement de Taylor à l'ordre 0, qui approxime le gradient, et qui doit
+  rester constant).
 
-  ResiduFormula
-    .. index:: single: ResiduFormula
+  Exemple :
+  ``{"ResiduFormula":"Taylor"}``
 
-    Cette clé indique la formule de résidu qui doit être utilisée pour le test.
-    Le choix par défaut est "Taylor", et les choix possibles sont "Taylor"
-    (résidu du développement de Taylor normalisé de l'opérateur, qui doit
-    décroître comme le carré de la perturbation), "TaylorOnNorm" (résidu du
-    développement de Taylor rapporté à la perturbation de l'opérateur, qui doit
-    rester constant) et "Norm" (résidu obtenu en prenant la norme du
-    développement de Taylor à l'ordre 0, qui approxime le gradient, et qui doit
-    rester constant).
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-    Exemple :
-    ``{"ResiduFormula":"Taylor"}``
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "CurrentState",
+  "Residu",
+  "SimulatedObservationAtCurrentState",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["CurrentState", "Residu",
-    "SimulatedObservationAtCurrentState"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+.. include:: snippets/Residu.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/CurrentState.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/Residu.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
-
-  .. include:: snippets/CurrentState.rst
-
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_FunctionTest`
-  - :ref:`section_ref_algorithm_LinearityTest`
-  - :ref:`section_ref_algorithm_TangentTest`
-  - :ref:`section_ref_algorithm_AdjointTest`
+- :ref:`section_ref_algorithm_FunctionTest`
+- :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_TangentTest`
+- :ref:`section_ref_algorithm_AdjointTest`
+- :ref:`section_ref_algorithm_LocalSensitivityTest`

diff --git a/doc/fr/ref_algorithm_KalmanFilter.rst b/doc/fr/ref_algorithm_KalmanFilter.rst
index 36e894922001d5bedb73d43719dfc92dea40be8a..65177734c61aeecaf629daad3dffbb0a17da6c9f 100644 (file)
--- a/doc/fr/ref_algorithm_KalmanFilter.rst
+++ b/doc/fr/ref_algorithm_KalmanFilter.rst
@@ -27,8 +27,8 @@
 Algorithme de calcul "*KalmanFilter*"
 -------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de l'état d'un système dynamique par un
 filtre de Kalman.
@@ -43,92 +43,81 @@ l':ref:`section_ref_algorithm_ExtendedKalmanFilter`, ou
 l':ref:`section_ref_algorithm_EnsembleKalmanFilter` et
 l':ref:`section_ref_algorithm_UnscentedKalmanFilter` qui sont plus puissants.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/EvolutionError.rst
 
-  .. include:: snippets/EvolutionError.rst
+.. include:: snippets/EvolutionModel.rst
 
-  .. include:: snippets/EvolutionModel.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/EstimationOf.rst
 
-Les options de l'algorithme sont les suivantes:
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/EstimationOf.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "APosterioriCorrelations",
+  "APosterioriCovariance",
+  "APosterioriStandardDeviations",
+  "APosterioriVariances",
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJb",
+  "CostFunctionJo",
+  "CurrentState",
+  "Innovation",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+  Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["APosterioriCorrelations",
-    "APosterioriCovariance", "APosterioriStandardDeviations",
-    "APosterioriVariances", "BMA", "CostFunctionJ", "CostFunctionJb",
-    "CostFunctionJo", "CurrentState", "Innovation"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-    Exemple : ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+.. include:: snippets/Analysis.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/APosterioriCorrelations.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriCovariance.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/APosterioriStandardDeviations.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/APosterioriVariances.rst
 
-  .. include:: snippets/APosterioriCorrelations.rst
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/APosterioriCovariance.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/APosterioriStandardDeviations.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/APosterioriVariances.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-  .. include:: snippets/CostFunctionJo.rst
-
-  .. include:: snippets/CurrentState.rst
-
-  .. include:: snippets/Innovation.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_ExtendedKalmanFilter`
-  - :ref:`section_ref_algorithm_EnsembleKalmanFilter`
-  - :ref:`section_ref_algorithm_UnscentedKalmanFilter`
+- :ref:`section_ref_algorithm_ExtendedKalmanFilter`
+- :ref:`section_ref_algorithm_EnsembleKalmanFilter`
+- :ref:`section_ref_algorithm_UnscentedKalmanFilter`

diff --git a/doc/fr/ref_algorithm_LinearLeastSquares.rst b/doc/fr/ref_algorithm_LinearLeastSquares.rst
index 02e47a4feed68c7c5367a2e0a2e02b987e224f89..d67065ba3d13ddea91e76e820088d08e14dc44fe 100644 (file)
--- a/doc/fr/ref_algorithm_LinearLeastSquares.rst
+++ b/doc/fr/ref_algorithm_LinearLeastSquares.rst
@@ -27,8 +27,8 @@
 Algorithme de calcul "*LinearLeastSquares*"
 -------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation linéaire de type "Moindres Carrés"
 pondérés. Il est similaire à l':ref:`section_ref_algorithm_Blue`
@@ -36,90 +36,77 @@ amputé de sa partie ébauche.
 
 Cet algorithme est toujours le plus rapide de l'ensemble des algorithmes
 d'optimisation d'ADAO. Il est théoriquement réservé aux cas d'opérateurs
-d'observation linéaires, même s'il fonctionne parfois dans les cas "faiblement"
-non-linéaire. On peut vérifier la linéarité de l'opérateur d'observation à
-l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
+d'observation explicitement linéaires, même s'il fonctionne parfois dans les
+cas "faiblement" non-linéaire. On peut vérifier la linéarité de l'opérateur
+d'observation à l'aide de l':ref:`section_ref_algorithm_LinearityTest`.
 
 Dans tous les cas, il est recommandé de lui préférer au minimum
 l':ref:`section_ref_algorithm_Blue`, voire
 l':ref:`section_ref_algorithm_ExtendedBlue` ou
 l':ref:`section_ref_algorithm_3DVAR`.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-Les options de l'algorithme sont les suivantes:
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "OMA",
+  "CurrentState",
+  "CostFunctionJ",
+  "CostFunctionJb",
+  "CostFunctionJo",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
-
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["OMA", "CurrentState",
-    "CostFunctionJ", "CostFunctionJb", "CostFunctionJo",
-    "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
-
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}``
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["OMA", "CurrentState"]}``
 
 *Astuce pour cet algorithme :*
 
     Comme les commandes *"Background"* et *"BackgroundError"* sont requises
     pour TOUS les algorithmes de calcul dans l'interface graphique, vous devez
-    fournir une valeur, malgré le fait que ces commandes ne sont pas requises
-    pour cet algorithme, et ne seront pas utilisées. La manière la plus simple
-    est de donner "1" comme un STRING pour les deux.
-
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+    fournir une valeur, malgré le fait que ces commandes ne soient pas
+    nécessaires pour cet algorithme, et ne sont donc pas utilisées. La manière
+    la plus simple est de donner "1" comme un STRING pour les deux.
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. include:: snippets/CostFunctionJo.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-Voir aussi
-++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_Blue`
-  - :ref:`section_ref_algorithm_ExtendedBlue`
-  - :ref:`section_ref_algorithm_3DVAR`
-  - :ref:`section_ref_algorithm_LinearityTest`
+- :ref:`section_ref_algorithm_Blue`
+- :ref:`section_ref_algorithm_ExtendedBlue`
+- :ref:`section_ref_algorithm_3DVAR`
+- :ref:`section_ref_algorithm_LinearityTest`

diff --git a/doc/fr/ref_algorithm_LinearityTest.rst b/doc/fr/ref_algorithm_LinearityTest.rst
index 16abbf9a90da2114d3365f758de66eef0ee9b092..aecefe403ba9642850a43d6ceeb4851314adcebb 100644 (file)
--- a/doc/fr/ref_algorithm_LinearityTest.rst
+++ b/doc/fr/ref_algorithm_LinearityTest.rst
@@ -27,8 +27,8 @@
 Algorithme de vérification "*LinearityTest*"
 --------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme permet de vérifier la qualité de linéarité de l'opérateur, en
 calculant un résidu dont les propriétés théoriques sont connues. Plusieurs
@@ -108,87 +108,71 @@ S'il est égal à 0 sur une partie seulement du domaine de variation de
 l'incrément :math:`\alpha`, c'est sur cette partie que l'hypothèse de linéarité
 de F est vérifiée.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/CheckingPoint.rst
 
-  .. include:: snippets/CheckingPoint.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03Chck.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_checking_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/AmplitudeOfInitialDirection.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/EpsilonMinimumExponent.rst
 
-  .. include:: snippets/AmplitudeOfInitialDirection.rst
+.. include:: snippets/InitialDirection.rst
 
-  .. include:: snippets/EpsilonMinimumExponent.rst
+.. include:: snippets/SetSeed.rst
 
-  .. include:: snippets/InitialDirection.rst
+ResiduFormula
+  .. index:: single: ResiduFormula
 
-  .. include:: snippets/SetSeed.rst
+  Cette clé indique la formule de résidu qui doit être utilisée pour le test.
+  Le choix par défaut est "CenteredDL", et les choix possibles sont
+  "CenteredDL" (résidu de la différence entre la fonction au point nominal et
+  ses valeurs avec des incréments positif et négatif, qui doit rester très
+  faible), "Taylor" (résidu du développement de Taylor de l'opérateur
+  normalisé par sa valeur nominal, qui doit rester très faible),
+  "NominalTaylor" (résidu de l'approximation à l'ordre 1 de l'opérateur,
+  normalisé au point nominal, qui doit rester proche de 1), et
+  "NominalTaylorRMS" (résidu de l'approximation à l'ordre 1 de l'opérateur,
+  normalisé par l'écart quadratique moyen (RMS) au point nominal, qui doit
+  rester proche de 0).
 
-  ResiduFormula
-    .. index:: single: ResiduFormula
+  Exemple :
+  ``{"ResiduFormula":"CenteredDL"}``
 
-    Cette clé indique la formule de résidu qui doit être utilisée pour le test.
-    Le choix par défaut est "CenteredDL", et les choix possibles sont
-    "CenteredDL" (résidu de la différence entre la fonction au point nominal et
-    ses valeurs avec des incréments positif et négatif, qui doit rester très
-    faible), "Taylor" (résidu du développement de Taylor de l'opérateur
-    normalisé par sa valeur nominal, qui doit rester très faible),
-    "NominalTaylor" (résidu de l'approximation à l'ordre 1 de l'opérateur,
-    normalisé au point nominal, qui doit rester proche de 1), et
-    "NominalTaylorRMS" (résidu de l'approximation à l'ordre 1 de l'opérateur,
-    normalisé par l'écart quadratique moyen (RMS) au point nominal, qui doit
-    rester proche de 0).
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-    Exemple :
-    ``{"ResiduFormula":"CenteredDL"}``
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "CurrentState",
+  "Residu",
+  "SimulatedObservationAtCurrentState",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["CurrentState"]}``
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["CurrentState", "Residu",
-    "SimulatedObservationAtCurrentState"].
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["CurrentState"]}``
+.. include:: snippets/Residu.rst
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. include:: snippets/CurrentState.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/Residu.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
-
-  .. include:: snippets/CurrentState.rst
-
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
-
-Voir aussi
-++++++++++
-
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_FunctionTest`
+- :ref:`section_ref_algorithm_FunctionTest`

diff --git a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst
index 5a58e45ed5d3cf86947e5c282c0e1b93584db702..32c9a131d2db2b2954b394d707f191b3a0c17844 100644 (file)
--- a/doc/fr/ref_algorithm_NonLinearLeastSquares.rst
+++ b/doc/fr/ref_algorithm_NonLinearLeastSquares.rst
@@ -27,8 +27,8 @@
 Algorithme de calcul "*NonLinearLeastSquares*"
 ----------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation d'état par minimisation variationnelle de
 la fonctionnelle :math:`J` d'écart classique de "Moindres Carrés" pondérés:
@@ -43,140 +43,123 @@ Dans tous les cas, il est recommandé de lui préférer
 l':ref:`section_ref_algorithm_3DVAR` pour sa stabilité comme pour son
 comportement lors de l'optimisation.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+Minimizer
+  .. index:: single: Minimizer
 
-Les options de l'algorithme sont les suivantes:
+  Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
+  défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
+  linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
+  (minimisation non linéaire sous contraintes), "CG" (minimisation non
+  linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
+  contraintes), "NCG" (minimisation de type gradient conjugué de Newton), "LM"
+  (minimisation non linéaire de type Levenberg-Marquard). Il est fortement
+  conseillé de conserver la valeur par défaut.
 
-  Minimizer
-    .. index:: single: Minimizer
+  Exemple :
+  ``{"Minimizer":"LBFGSB"}``
 
-    Cette clé permet de changer le minimiseur pour l'optimiseur. Le choix par
-    défaut est "LBFGSB", et les choix possibles sont "LBFGSB" (minimisation non
-    linéaire sous contraintes, voir [Byrd95]_, [Morales11]_ et [Zhu97]_), "TNC"
-    (minimisation non linéaire sous contraintes), "CG" (minimisation non
-    linéaire sans contraintes), "BFGS" (minimisation non linéaire sans
-    contraintes), "NCG" (minimisation de type gradient conjugué de Newton), "LM"
-    (minimisation non linéaire de type Levenberg-Marquard). Il est fortement
-    conseillé de conserver la valeur par défaut.
+.. include:: snippets/BoundsWithNone.rst
 
-    Exemple :
-    ``{"Minimizer":"LBFGSB"}``
+.. include:: snippets/MaximumNumberOfSteps.rst
 
-  .. include:: snippets/BoundsWithNone.rst
+.. include:: snippets/CostDecrementTolerance.rst
 
-  .. include:: snippets/MaximumNumberOfSteps.rst
+.. include:: snippets/ProjectedGradientTolerance.rst
 
-  .. include:: snippets/CostDecrementTolerance.rst
+.. include:: snippets/GradientNormTolerance.rst
 
-  .. include:: snippets/ProjectedGradientTolerance.rst
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/GradientNormTolerance.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
+  "CostFunctionJb", "CostFunctionJo", "CostFunctionJAtCurrentOptimum",
+  "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum",
+  "CurrentState", "CurrentOptimum", "IndexOfOptimum", "Innovation",
+  "InnovationAtCurrentState", "OMA", "OMB",
+  "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum", "SimulatedObservationAtCurrentOptimum"].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
-
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
-    "CostFunctionJb", "CostFunctionJo", "CostFunctionJAtCurrentOptimum",
-    "CostFunctionJbAtCurrentOptimum", "CostFunctionJoAtCurrentOptimum",
-    "CurrentState", "CurrentOptimum", "IndexOfOptimum", "Innovation",
-    "InnovationAtCurrentState", "OMA", "OMB",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
-    "SimulatedObservationAtOptimum", "SimulatedObservationAtCurrentOptimum"].
-
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 *Astuce pour cet algorithme :*
 
     Comme la commande *"BackgroundError"* est requise pour TOUS les algorithmes
     de calcul dans l'interface graphique, vous devez fournir une valeur, malgré
-    le fait que cette commande n'est pas requise pour cet algorithme, et ne
-    sera pas utilisée. La manière la plus simple est de donner "1" comme un
-    STRING.
-
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+    le fait que cette commande ne soit pas nécessaire pour cet algorithme, et
+    n'est donc pas utilisée. La manière la plus simple est de donner "1" comme
+    un STRING.
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CostFunctionJAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJAtCurrentOptimum.rst
+.. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJbAtCurrentOptimum.rst
+.. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
 
-  .. include:: snippets/CostFunctionJoAtCurrentOptimum.rst
+.. include:: snippets/CurrentOptimum.rst
 
-  .. include:: snippets/CurrentOptimum.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. include:: snippets/IndexOfOptimum.rst
 
-  .. include:: snippets/IndexOfOptimum.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/InnovationAtCurrentState.rst
 
-  .. include:: snippets/InnovationAtCurrentState.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/OMB.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/SimulatedObservationAtBackground.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
+.. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentOptimum.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Voir aussi
-++++++++++
+- :ref:`section_ref_algorithm_3DVAR`
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_3DVAR`
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-Références bibliographiques :
-  - [Byrd95]_
-  - [Morales11]_
-  - [Zhu97]_
+- [Byrd95]_
+- [Morales11]_
+- [Zhu97]_

diff --git a/doc/fr/ref_algorithm_ObserverTest.rst b/doc/fr/ref_algorithm_ObserverTest.rst
index 8b9653cdd702458c57fbec011a2b03bec871a17b..b0794409c5b25ae07e54aa705efcc0260770e38e 100644 (file)
--- a/doc/fr/ref_algorithm_ObserverTest.rst
+++ b/doc/fr/ref_algorithm_ObserverTest.rst
@@ -27,8 +27,8 @@
 Algorithme de vérification "*ObserverTest*"
 -------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme permet de vérifier une fonction externe et fournie par
 l'utilisateur, utilisée comme un *observer*. Cette fonction externe peut être
@@ -36,13 +36,10 @@ appliquée à chacune des variables potentiellement observables. Elle n'est
 activée que sur celles qui sont explicitement associées avec l'*observer* dans
 l'interface.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
-
-  .. include:: snippets/Observers.rst
+.. include:: snippets/Observers.rst
 
 Les commandes optionnelles générales, disponibles dans l'interface en édition,
 sont indiquées dans la :ref:`section_ref_checking_keywords`.
@@ -51,7 +48,7 @@ sont indiquées dans la :ref:`section_ref_checking_keywords`.
 
     Comme les commandes *"CheckingPoint"* et *"ObservationOperator"* sont
     requises pour TOUS les algorithmes de vérification dans l'interface, vous
-    devez fournir une valeur, malgré le fait que ces commandes ne sont pas
-    requises pour *"ObserverTest"*, et ne seront pas utilisées. La manière la
-    plus simple est de donner "1" comme un STRING pour les deux,
+    devez fournir une valeur, malgré le fait que ces commandes ne soient pas
+    nécessaires pour cet algorithme, et ne sont donc pas utilisées. La manière
+    la plus simple est de donner "1" comme un STRING pour les deux,
     l'*"ObservationOperator"* devant être de type *Matrix*.

diff --git a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst
index a94ea222a8addee7a8197bca298236eabdb3e703..083a7aa05a9c0d1e311afc8e20e4142b1ad7bd14 100644 (file)
--- a/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst
+++ b/doc/fr/ref_algorithm_ParticleSwarmOptimization.rst
@@ -27,15 +27,16 @@
 Algorithme de calcul "*ParticleSwarmOptimization*"
 --------------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme réalise une estimation de l'état d'un système par minimisation
 d'une fonctionnelle d'écart :math:`J` en utilisant une méthode évolutionnaire
 d'essaim particulaire. C'est une méthode qui n'utilise pas les dérivées de la
 fonctionnelle d'écart. Elle entre dans la même catégorie que
-l':ref:`section_ref_algorithm_DerivativeFreeOptimization` ou
-l':ref:`section_ref_algorithm_DifferentialEvolution`.
+l':ref:`section_ref_algorithm_DerivativeFreeOptimization`,
+l':ref:`section_ref_algorithm_DifferentialEvolution` ou
+l':ref:`section_ref_algorithm_TabuSearch`.
 
 C'est une méthode d'optimisation permettant la recherche du minimum global d'une
 fonctionnelle d'erreur :math:`J` quelconque de type :math:`L^1`, :math:`L^2` ou
@@ -43,138 +44,132 @@ fonctionnelle d'erreur :math:`J` quelconque de type :math:`L^1`, :math:`L^2` ou
 défaut est celle de moindres carrés pondérés augmentés, classiquement utilisée
 en assimilation de données.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/BackgroundError.rst
 
-  .. include:: snippets/BackgroundError.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationError.rst
 
-  .. include:: snippets/ObservationError.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
-
-Les options de l'algorithme sont les suivantes:
 .. index:: single: NumberOfInsects
 .. index:: single: SwarmVelocity
 .. index:: single: GroupRecallRate
 .. index:: single: QualityCriterion
 .. index:: single: BoxBounds
 
-  .. include:: snippets/MaximumNumberOfSteps_50.rst
-
-  .. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
+.. include:: snippets/MaximumNumberOfSteps_50.rst
 
-  .. include:: snippets/QualityCriterion.rst
+.. include:: snippets/MaximumNumberOfFunctionEvaluations.rst
 
-  NumberOfInsects
-    Cette clé indique le nombre d'insectes ou de particules dans l'essaim. La
-    valeur par défaut est 100, qui est une valeur par défaut usuelle pour cet
-    algorithme.
+.. include:: snippets/QualityCriterion.rst
 
-    Exemple :
-    ``{"NumberOfInsects":100}``
+NumberOfInsects
+  Cette clé indique le nombre d'insectes ou de particules dans l'essaim. La
+  valeur par défaut est 100, qui est une valeur par défaut usuelle pour cet
+  algorithme.
 
-  SwarmVelocity
-    Cette clé indique la part de la vitesse d'insecte qui est imposée par
-    l'essaim. C'est une valeur réelle positive. Le défaut est de 1.
+  Exemple :
+  ``{"NumberOfInsects":100}``
 
-    Exemple :
-    ``{"SwarmVelocity":1.}``
+SwarmVelocity
+  Cette clé indique la part de la vitesse d'insecte qui est imposée par
+  l'essaim. C'est une valeur réelle positive. Le défaut est de 1.
 
-  GroupRecallRate
-    Cette clé indique le taux de rappel vers le meilleur insecte de l'essaim.
-    C'est une valeur réelle comprise entre 0 et 1. Le défaut est de 0.5.
+  Exemple :
+  ``{"SwarmVelocity":1.}``
 
-    Exemple :
-    ``{"GroupRecallRate":0.5}``
+GroupRecallRate
+  Cette clé indique le taux de rappel vers le meilleur insecte de l'essaim.
+  C'est une valeur réelle comprise entre 0 et 1. Le défaut est de 0.5.
 
-  BoxBounds
-    Cette clé permet de définir des bornes supérieure et inférieure pour chaque
-    incrément de  variable d'état optimisée (et non pas chaque variable d'état
-    elle-même). Les bornes doivent être données par une liste de liste de paires
-    de bornes inférieure/supérieure pour chaque incrément de variable, avec une
-    valeur extrême chaque fois qu'il n'y a pas de borne (``None`` n'est pas une
-    valeur autorisée lorsqu'il n'y a pas de borne). Cette clé est requise et il
-    n'y a pas de valeurs par défaut.
+  Exemple :
+  ``{"GroupRecallRate":0.5}``
 
-    Exemple :
-    ``{"BoxBounds":[[-0.5,0.5], [0.01,2.], [0.,1.e99], [-1.e99,1.e99]]}``
+BoxBounds
+  Cette clé permet de définir des bornes supérieure et inférieure pour chaque
+  incrément de  variable d'état optimisée (et non pas chaque variable d'état
+  elle-même). Les bornes doivent être données par une liste de liste de paires
+  de bornes inférieure/supérieure pour chaque incrément de variable, avec une
+  valeur extrême chaque fois qu'il n'y a pas de borne (``None`` n'est pas une
+  valeur autorisée lorsqu'il n'y a pas de borne). Cette clé est requise et il
+  n'y a pas de valeurs par défaut.
 
-  .. include:: snippets/SetSeed.rst
+  Exemple :
+  ``{"BoxBounds":[[-0.5,0.5], [0.01,2.], [0.,1.e99], [-1.e99,1.e99]]}``
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
+.. include:: snippets/SetSeed.rst
 
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["BMA", "CostFunctionJ", "CostFunctionJb",
-    "CostFunctionJo", "CurrentState", "OMA", "OMB", "Innovation",
-    "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState",
-    "SimulatedObservationAtOptimum"].
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJb",
+  "CostFunctionJo",
+  "CurrentState",
+  "OMA",
+  "OMB",
+  "Innovation",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  ].
 
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/OMB.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/SimulatedObservationAtBackground.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Voir aussi
-++++++++++
+- :ref:`section_ref_algorithm_DerivativeFreeOptimization`
+- :ref:`section_ref_algorithm_DifferentialEvolution`
+- :ref:`section_ref_algorithm_TabuSearch`
 
-Références vers d'autres sections :
-  - :ref:`section_ref_algorithm_DerivativeFreeOptimization`
-  - :ref:`section_ref_algorithm_DifferentialEvolution`
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-Références bibliographiques :
-  - [WikipediaPSO]_
+- [WikipediaPSO]_

diff --git a/doc/fr/ref_algorithm_QuantileRegression.rst b/doc/fr/ref_algorithm_QuantileRegression.rst
index b59ef03c2889175d5bf9c26d6ed5bee485d5db6e..7b80715f4f8eb08b8e53a9e71e82e54d8bb9b0d7 100644 (file)
--- a/doc/fr/ref_algorithm_QuantileRegression.rst
+++ b/doc/fr/ref_algorithm_QuantileRegression.rst
@@ -27,111 +27,104 @@
 Algorithme de calcul "*QuantileRegression*"
 -------------------------------------------
 
-Description
-+++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo01.rst
 
 Cet algorithme permet d'estimer les quantiles conditionnels de la distribution
 des paramètres d'état, exprimés à l'aide d'un modèle des variables observées. Ce
 sont donc les quantiles sur les variables observées qui vont permettre de
 déterminer les paramètres de modèles satisfaisant aux conditions de quantiles.
 
-Commandes requises et optionnelles
-++++++++++++++++++++++++++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo02.rst
 
-Les commandes requises générales, disponibles dans l'interface en édition, sont
-les suivantes:
+.. include:: snippets/Background.rst
 
-  .. include:: snippets/Background.rst
+.. include:: snippets/Observation.rst
 
-  .. include:: snippets/Observation.rst
+.. include:: snippets/ObservationOperator.rst
 
-  .. include:: snippets/ObservationOperator.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo03AdOp.rst
 
-Les commandes optionnelles générales, disponibles dans l'interface en édition,
-sont indiquées dans la :ref:`section_ref_assimilation_keywords`. De plus, les
-paramètres de la commande "*AlgorithmParameters*" permettent d'indiquer les
-options particulières, décrites ci-après, de l'algorithme. On se reportera à la
-:ref:`section_ref_options_Algorithm_Parameters` pour le bon usage de cette
-commande.
+.. include:: snippets/Quantile.rst
 
-Les options de l'algorithme sont les suivantes:
+.. include:: snippets/MaximumNumberOfSteps.rst
 
-  .. include:: snippets/Quantile.rst
+.. include:: snippets/CostDecrementTolerance_6.rst
 
-  .. include:: snippets/MaximumNumberOfSteps.rst
+.. include:: snippets/BoundsWithNone.rst
 
-  .. include:: snippets/CostDecrementTolerance_6.rst
+StoreSupplementaryCalculations
+  .. index:: single: StoreSupplementaryCalculations
 
-  .. include:: snippets/BoundsWithNone.rst
+  Cette liste indique les noms des variables supplémentaires qui peuvent être
+  disponibles à la fin de l'algorithme. Cela implique potentiellement des
+  calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
+  aucune de ces variables n'étant calculée et stockée par défaut. Les noms
+  possibles sont dans la liste suivante : [
+  "BMA",
+  "CostFunctionJ",
+  "CostFunctionJb",
+  "CostFunctionJo",
+  "CurrentState",
+  "OMA",
+  "OMB",
+  "Innovation",
+  "SimulatedObservationAtBackground",
+  "SimulatedObservationAtCurrentState",
+  "SimulatedObservationAtOptimum",
+  ].
 
-  StoreSupplementaryCalculations
-    .. index:: single: StoreSupplementaryCalculations
-
-    Cette liste indique les noms des variables supplémentaires qui peuvent être
-    disponibles à la fin de l'algorithme. Cela implique potentiellement des
-    calculs ou du stockage coûteux. La valeur par défaut est une liste vide,
-    aucune de ces variables n'étant calculée et stockée par défaut. Les noms
-    possibles sont dans la liste suivante : ["BMA", "CostFunctionJ",
-    "CostFunctionJb", "CostFunctionJo", "CurrentState", "OMA", "OMB",
-    "Innovation", "SimulatedObservationAtBackground",
-    "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"].
-
-    Exemple :
-    ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
+  Exemple :
+  ``{"StoreSupplementaryCalculations":["BMA", "Innovation"]}``
 
 *Astuce pour cet algorithme :*
 
     Comme les commandes *"BackgroundError"* et *"ObservationError"* sont
     requises pour TOUS les algorithmes de calcul dans l'interface graphique,
-    vous devez fournir une valeur, malgré le fait que ces commandes ne sont pas
-    requises pour cet algorithme, et ne seront pas utilisées. La manière la
-    plus simple est de donner "1" comme un STRING pour les deux.
-
-Informations et variables disponibles à la fin de l'algorithme
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+    vous devez fournir une valeur, malgré le fait que ces commandes ne soient
+    pas nécessaires pour cet algorithme, et ne sont donc pas utilisées. La
+    manière la plus simple est de donner "1" comme un STRING pour les deux.
 
-En sortie, après exécution de l'algorithme, on dispose d'informations et de
-variables issues du calcul. La description des
-:ref:`section_ref_output_variables` indique la manière de les obtenir par la
-méthode nommée ``get`` de la variable "*ADD*" du post-processing. Les variables
-d'entrée, mises à disposition de l'utilisateur en sortie pour faciliter
-l'écriture des procédures de post-processing, sont décrites dans
-l':ref:`subsection_r_o_v_Inventaire`.
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo04.rst
 
-Les sorties non conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/Analysis.rst
 
-  .. include:: snippets/Analysis.rst
+.. include:: snippets/CostFunctionJ.rst
 
-  .. include:: snippets/CostFunctionJ.rst
+.. include:: snippets/CostFunctionJb.rst
 
-  .. include:: snippets/CostFunctionJb.rst
+.. include:: snippets/CostFunctionJo.rst
 
-  .. include:: snippets/CostFunctionJo.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo05.rst
 
-Les sorties conditionnelles de l'algorithme sont les suivantes:
+.. include:: snippets/BMA.rst
 
-  .. include:: snippets/BMA.rst
+.. include:: snippets/CurrentState.rst
 
-  .. include:: snippets/CurrentState.rst
+.. include:: snippets/Innovation.rst
 
-  .. include:: snippets/Innovation.rst
+.. include:: snippets/OMA.rst
 
-  .. include:: snippets/OMA.rst
+.. include:: snippets/OMB.rst
 
-  .. include:: snippets/OMB.rst
+.. include:: snippets/SimulatedObservationAtBackground.rst
 
-  .. include:: snippets/SimulatedObservationAtBackground.rst
+.. include:: snippets/SimulatedObservationAtCurrentState.rst
 
-  .. include:: snippets/SimulatedObservationAtCurrentState.rst
+.. include:: snippets/SimulatedObservationAtOptimum.rst
 
-  .. include:: snippets/SimulatedObservationAtOptimum.rst
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo06.rst
 
-Voir aussi
-++++++++++
+.. ------------------------------------ ..
+.. include:: snippets/Header2Algo07.rst
 
-Références bibliographiques :
-  - [Buchinsky98]_
-  - [Cade03]_
-  - [Koenker00]_
-  - [Koenker01]_
-  - [WikipediaQR]_
+- [Buchinsky98]_
+- [Cade03]_
+- [Koenker00]_
+- [Koenker01]_
+- [WikipediaQR]_