doc/index.rst

   1
   2 ================================================================================
   3 ADAO module documentation
   4 ================================================================================
   5
   6 The ADAO module provides **data assimilation** features in SALOME context. It is
   7 based on usage of other SALOME modules, namely YACS and EFICAS, and on an
   8 extensible generic underlying data assimilation library.
   9
  10 Briefly stated, Data Assimilation is a methodological framework to compute the
  11 optimal estimate of the inaccessible true value of a system state over time. It
  12 uses information coming from experimental measurements or observations, and from
  13 numerical *a priori* models, including information about their errors. Parts of
  14 the framework are also known as *parameter estimation*, *inverse problems*,
  15 *bayesian estimation*, *optimal interpolation*, etc. More details can be found
  16 in the section :ref:`section_theory`.
  17
  18 The documentation of this module is divided in 5 parts, the first one being an
  19 introduction. The second part briefly introduces data assimilation and concepts.
  20 The third part describes how to use the module ADAO. The fourth part gives
  21 examples on ADAO usage. Users interested in quick use of the module can jump to
  22 this section :ref:`section_examples`, but a valuable use of the module requires
  23 to read and come back regularly to the section :ref:`section_using`. The last
  24 part focuses on advanced usages of the module, how to get more information, or
  25 how to use it without the graphical user interface (GUI).
  26
  27 In all this documentation, we use standard notations of data assimilation, as
  28 described in [Ide97]. Moreover, vectors are written horizontally or vertically
  29 without making difference. Matrices are written either normally, or with a
  30 condensed notation, consisting in the use of a space to separate values and a
  31 "``;``" to separate the rows, in a continuous line.
  32
  33 .. toctree::
  34    :maxdepth: 2
  35
  36    intro
  37    theory
  38    using
  39    examples
  40    advanced
  41    bibliography
  42
  43 Indices and tables
  44 ================================================================================
  45
  46 * :ref:`genindex`
  47 * :ref:`search`
  48 * :ref:`section_glossary`