doc/index.rst

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