Salome HOME
Installation des icones
[modules/adao.git] / doc / index.rst
index bd3bbbea4301474c2bfc8772e834a8482ae9cecc..0385fcfb860a402eff42efe37a0fea0d91d8ec2a 100644 (file)
@@ -1,18 +1,45 @@
 
-ADAO documentation
-==================
+================================================================================
+ADAO module documentation
+================================================================================
 
-Contents:
+The ADAO module provides **data assimilation** features in SALOME context. It is
+based on usage on other SALOME modules, namely YACS and EFICAS, and on an
+extensible generic underlying data assimilation library.
+
+Briefly stated, Data Assimilation is a methodological framework to compute the
+optimal estimate of the inaccessible true value of a system state over time. It
+uses information coming from experimental measurements or observations, and from
+numerical *a priori* models, including information about their errors. Parts of
+the framework are also known as *parameter estimation*, *inverse problems*,
+*bayesian estimation*, *optimal interpolation*, etc. More details can be found
+in the section :ref:`section_theory`.
+
+The documentation of this module is divided in 5 parts, the first one being an
+introduction. The second part briefly introduces data assimilation and concepts.
+The third part describes how to use the module ADAO. The fourth part focuses on
+advanced usages of the module, how to get more information, or how to use it
+without the graphical user interface (GUI). The last part gives examples on ADAO
+usage. Users interested in quick use of the module can jump to the section
+:ref:`section_examples`, but a valuable use of the module requires to read and
+come back regularly the section :ref:`section_using`.
+
+In all this documentation, we use standard notations of data assimilation.
+Moreover, vectors are written horizontally or vertically without difference.
+Matrices are written either normally, either with a condensed notation,
+consisting in the use of a "``;``" to separate the rows in a continuous line.
 
 .. toctree::
-  :maxdepth: 2
+   :maxdepth: 2
 
-  intro
+   intro
+   theory
+   using
+   advanced
+   examples
 
 Indices and tables
-==================
+================================================================================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
-