doc/index.rst

   1 ================================================================================
   2 ADAO module documentation
   3 ================================================================================
   4
   5 .. image:: images/ADAO_logo.png
   6    :align: center
   7    :scale: 10%
   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 is an
  22 introduction. The second part briefly introduces data assimilation and concepts.
  23 The third part describes how to use the module ADAO. The fourth part gives
  24 examples on ADAO usage. Users interested in quick use of the module can jump to
  25 this fourth section :ref:`section_examples`, but a valuable use of the module
  26 requires to read and come back regularly to the third one :ref:`section_using`.
  27 The last part focuses on advanced usages of the module, how to get more
  28 information, or how to use it by scripting, without the graphical user interface
  29 (GUI).
  30
  31 In all this documentation, we use standard notations of linear algebra, data
  32 assimilation (as described in [Ide97]) and optimization. In particular, vectors
  33 are written horizontally or vertically without making difference. Matrices are
  34 written either normally, or with a condensed notation, consisting in the use of
  35 a space to separate values and a "``;``" to separate the rows, in a continuous
  36 line.
  37
  38 Table of contents
  39 -----------------
  40
  41 .. toctree::
  42    :maxdepth: 2
  43
  44    intro
  45    theory
  46    using
  47    examples
  48    advanced
  49    bibliography
  50
  51 Indices and tables
  52 ------------------
  53
  54 * :ref:`genindex`
  55 * :ref:`search`
  56 * :ref:`section_glossary`