Salome HOME
Amélioration de la bibliographie et des exemples
[modules/adao.git] / doc / index.rst
index 68160597cdc0a53288e5e041d1692096cfc6fcde..fe3a54c55148afa916fb9acd4965dc6650f138f6 100644 (file)
@@ -3,47 +3,45 @@
 ADAO module documentation
 ================================================================================
 
-The ADAO module provides **data assimilation** features [#]_ in SALOME context.
-It is based on an extensible generic underlying data assimilation library, and
-on usage on other SALOME modules, namely YACS and EFICAS.
+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 inaccesible true value of a system state over time. It
+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.
-
-The documentation of this module is divided in 4 parts, the first one being an
-introduction. The second part describes how to use the module ADAO. The third
+*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 gives
+examples on ADAO usage. Users interested in quick use of the module can jump to
+this section :ref:`section_examples`, but a valuable use of the module requires
+to read and come back regularly to the section :ref:`section_using`. The last
 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 last part, but a
-valuable use of the module requires to read and come back regularly the second
-part.
+how to use it without the graphical user interface (GUI). 
 
-In all this documentation, we use standard notations of data assimilation.
-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.
+In all this documentation, we use standard notations of data assimilation, as
+described in [Ide97]. Moreover, vectors are written horizontally or vertically
+without making difference. Matrices are written either normally, or with a
+condensed notation, consisting in the use of a space to separate values and a
+"``;``" to separate the rows, in a continuous line.
 
 .. toctree::
    :maxdepth: 2
 
    intro
+   theory
    using
-   advanced
    examples
+   advanced
+   bibliography
 
 Indices and tables
 ================================================================================
 
 * :ref:`genindex`
 * :ref:`search`
-
-.. _ECMWF: http://www.ecmwf.int/newsevents/training/rcourse_notes/DATA_ASSIMILATION/ASSIM_CONCEPTS/Assim_concepts.html
-.. _Wikipedia/Data_assimilation: http://en.wikipedia.org/wiki/Data_assimilation
-
-.. [#] If you are not familiar with data assimilation concepts in general, an introductory on-line training course can be found at ECMWF_, along with other materials coming from geosciences applications. See also for example `Wikipedia/Data_assimilation`_. Note that data assimilation is not restricted to meteorology or geosciences, but is widely used in other scientific domains.