Salome HOME
Updating documentation to cite Python (!)
[modules/adao.git] / doc / fr / index.rst
1 ..
2    Copyright (C) 2008-2018 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]_. Il est
36 basé sur l'utilisation d'autres modules, à savoir YACS et EFICAS s'ils sont
37 disponibles, et sur l'utilisation d'une bibliothèque et d'outils génériques
38 sous-jacents d'assimilation de données.
39
40 En bref, l'assimilation de données est un cadre méthodologique pour calculer
41 l'estimation optimale de la valeur réelle (inaccessible) de l'état d'un
42 système, éventuellement au cours du temps. Il utilise des informations
43 provenant de mesures expérimentales, ou observations, et de modèles numériques
44 *a priori*, y compris des informations sur leurs erreurs. Certaines des
45 méthodes incluses dans ce cadre sont également connues sous les noms
46 d'*estimation des paramètres*, de *problèmes inverses*, d'*estimation
47 bayésienne*, d'*interpolation optimale*, etc. De plus amples détails peuvent
48 être trouvés dans la partie proposant :ref:`section_theory`.
49
50 La documentation de ce module est divisée en plusieurs grandes catégories,
51 relatives à la documentation théorique (indiquée dans le titre par **[DocT]**),
52 à la documentation utilisateur (indiquée dans le titre par **[DocU]**), et à la
53 documentation de référence (indiquée dans le titre par **[DocR]**).
54
55 La première partie est l':ref:`section_intro`. La seconde partie présente
56 :ref:`section_theory`, et à leurs concepts, et la partie suivante décrit la
57 :ref:`section_methodology`. Pour un utilisateur courant, la quatrième partie
58 explique comment :ref:`section_using`, et la cinquième partie présente des
59 exemples d'utilisation sous la forme de :ref:`section_examples`. Les
60 utilisateurs intéressés par un accès rapide au module peuvent s'arrêter avant la
61 lecture de la suite, mais un usage utile du module nécessite de lire et de
62 revenir régulièrement aux quatrième et septième parties. La sixième partie
63 indique les :ref:`section_advanced`, avec l'obtention de renseignements
64 supplémentaires ou l'usage par scripts d'exécution sans interface utilisateur
65 graphique (GUI). La septième partie détaille la :ref:`section_reference`, avec
66 quatre sous-parties principales qui suivent, la dernière décrivant une
67 :ref:`section_tui` du module. Enfin, pour respecter les exigences de licence du
68 module, n'oubliez pas de lire la partie :ref:`section_license`.
69
70 Dans cette documentation, on utilise les notations standards de l'algèbre
71 linéaire, de l'assimilation de données (comme décrit dans [Ide97]_) et de
72 l'optimisation. En particulier, les vecteurs sont écrits horizontalement ou
73 verticalement sans faire la différence. Les matrices sont écrites soit
74 normalement, ou avec une notation condensée, consistant à utiliser un espace
75 pour séparer les valeurs, et un "``;``" pour séparer les lignes de la matrice,
76 de façon continue sur une ligne.
77
78 Table des matières
79 ------------------
80
81 .. toctree::
82    :maxdepth: 2
83
84    intro
85    theory
86    methodology
87    using
88    examples
89    advanced
90    reference
91    tui
92    license
93    glossary
94    bibliography
95
96 Index et tables
97 ---------------
98
99 * :ref:`genindex`
100 * :ref:`search`
101
102 .. * :ref:`section_glossary`