Salome HOME
Adding documentation and warning check for user file names
[modules/adao.git] / doc / fr / index.rst
index 887eea5daae37b3189559a0673571ea9541382c5..a74f45c897280c3608f9f29da8c8e308a3608731 100644 (file)
@@ -1,5 +1,5 @@
 ..
-   Copyright (C) 2008-2015 EDF R&D
+   Copyright (C) 2008-2019 EDF R&D
 
    This file is part of SALOME ADAO module.
 
@@ -29,63 +29,67 @@ Documentation ADAO
 
 .. image:: images/ADAO_logo.png
    :align: center
-   :width: 20%
-
-Le module ADAO fournit des fonctionnalités d'**assimilation de données et
-d'optimisation** dans un contexte SALOME. Il est basé sur l'utilisation d'autres
-modules, à savoir YACS et EFICAS, et sur l'utilisation d'une bibliothèque
-générique sous-jacente d'assimilation de données.
-
-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 système
-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
+   :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]_.
+
+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
+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 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 parties. La première est
-une :ref:`section_intro`. La seconde partie présente :ref:`section_theory`, et à
-leurs concepts. La troisième partie explique comment :ref:`section_using`.  La
-quatrième partie présente des exemples d'utilisation sous la forme de
-:ref:`section_examples`. La cinquième partie détaille la
-:ref:`section_reference`. Les utilisateurs intéressés par un accès rapide au
-module peuvent s'arrêter avant la lecture de cette partie, mais un usage utile
-du module nécessite de lire et de revenir régulièrement aux troisième et
-cinquième parties. La dernière partie se focalise sur des
-:ref:`section_advanced`, sur l'obtention de renseignements supplémentaires, ou
-sur l'usage par scripts, sans interface utilisateur graphique (GUI). 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
-l'optimisation. En particulier, les vecteurs sont écrits horizontalement ou
-verticalement sans faire la différence. Les matrices sont écrites soit
-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
-------------------
+La documentation de ce module est divisée en plusieurs grandes catégories,
+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, 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. Un
+:ref:`section_glossary`, des :ref:`section_notations`, une
+:ref:`section_bibliography` et un :ref:`genindex` développés complètent le
+document. Enfin, pour respecter les exigences de licence du module, n'oubliez
+pas de lire la partie :ref:`section_license`.
+
+**Table des matières**
 
 .. toctree::
    :maxdepth: 2
 
    intro
    theory
-   using
-   examples
+   methodology
+   tutorials_in_salome
+   tutorials_in_python
    advanced
+   gui_in_salome
+   tui
    reference
    license
    glossary
+   notations
    bibliography
 
-Index et tables
----------------
+**Index et tables**
 
 * :ref:`genindex`
 * :ref:`search`