Salome HOME
Adding documentation and warning check for user file names
[modules/adao.git] / doc / fr / index.rst
1 ..
2    Copyright (C) 2008-2019 EDF R&D
3
4    This file is part of SALOME ADAO module.
5
6    This library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    This library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with this library; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19
20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21
22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
23
24 .. _section_home:
25
26 ================================================================================
27 Documentation ADAO
28 ================================================================================
29
30 .. image:: images/ADAO_logo.png
31    :align: center
32    :alt: Logo ADAO
33
34 **Le module ADAO fournit des fonctionnalités d'assimilation de données et
35 d'optimisation** dans un contexte Python [Python]_ ou SALOME [Salome]_.
36
37 En bref, l'assimilation de données est un cadre méthodologique pour calculer
38 l'estimation optimale de la valeur réelle (inaccessible) de l'état d'un
39 système, éventuellement au cours du temps. Il utilise des informations
40 provenant de mesures expérimentales, ou observations, et de modèles numériques
41 *a priori*, y compris des informations sur leurs erreurs. Certaines des
42 méthodes incluses dans ce cadre sont également connues sous les noms
43 d'*estimation de paramètres*, de *problèmes inverses*, d'*estimation
44 bayésienne*, d'*interpolation optimale*, de *reconstruction de champs*, etc. De
45 plus amples détails peuvent être trouvés dans la partie proposant
46 :ref:`section_theory`.
47
48 La documentation de ce module est divisée en plusieurs grandes catégories,
49 relatives à la documentation théorique (indiquée dans le titre de section par
50 **[DocT]**), à la documentation utilisateur (indiquée dans le titre de section
51 par **[DocU]**), et à la documentation de référence (indiquée dans le titre de
52 section par **[DocR]**).
53
54 La première partie est l':ref:`section_intro`. La seconde partie présente
55 :ref:`section_theory`, et à leurs concepts, et la partie suivante décrit la
56 :ref:`section_methodology`. Pour un utilisateur courant, les parties suivantes
57 présentent des exemples didactiques d'utilisation sous la forme de
58 :ref:`section_tutorials_in_salome` ou de :ref:`section_tutorials_in_python`,
59 puis indique les :ref:`section_advanced`, avec l'obtention de renseignements
60 supplémentaires ou l'usage par scripts de commandes hors interface de contrôle
61 graphique. Les utilisateurs intéressés par un accès rapide au module peuvent
62 s'arrêter avant la lecture de la suite, mais un usage utile du module nécessite
63 de lire et de revenir régulièrement à ces parties. Les parties qui suivent
64 expliquent comment utiliser une :ref:`section_gui_in_salome` ou une
65 :ref:`section_tui`. La dernière grande partie détaille la
66 :ref:`section_reference`, avec trois sous-parties essentielles qui la composent
67 et qui décrivent les commandes et des options d'algorithmes. Un
68 :ref:`section_glossary`, des :ref:`section_notations`, une
69 :ref:`section_bibliography` et un :ref:`genindex` développés complètent le
70 document. Enfin, pour respecter les exigences de licence du module, n'oubliez
71 pas de lire la partie :ref:`section_license`.
72
73 **Table des matières**
74
75 .. toctree::
76    :maxdepth: 2
77
78    intro
79    theory
80    methodology
81    tutorials_in_salome
82    tutorials_in_python
83    advanced
84    gui_in_salome
85    tui
86    reference
87    license
88    glossary
89    notations
90    bibliography
91
92 **Index et tables**
93
94 * :ref:`genindex`
95 * :ref:`search`
96
97 .. * :ref:`section_glossary`