doc/en/index.rst

   1 ================================================================================
   2 ADAO 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 is an
  22 :ref:`section_intro`. The second part introduces :ref:`section_theory`, and
  23 their concepts. The third part describes :ref:`section_using`. The fourth part
  24 gives examples on ADAO usage as :ref:`section_examples`. The fifth part gives a
  25 detailed :ref:`section_reference`. Users interested in quick use of the module
  26 can stop reading before this fifth part, but a valuable use of the module
  27 requires to read and come back regularly to the third and fifth ones. The last
  28 part focuses on :ref:`section_advanced`, how to get more information, or how to
  29 use it by scripting, without the graphical user interface (GUI). And, to respect
  30 the module requirements, be sure to read the part :ref:`section_license`.
  31
  32 In all this documentation, we use standard notations of linear algebra, data
  33 assimilation (as described in [Ide97]_) and optimization. In particular, vectors
  34 are written horizontally or vertically without making difference. Matrices are
  35 written either normally, or with a condensed notation, consisting in the use of
  36 a space to separate values and a "``;``" to separate the rows, in a continuous
  37 line.
  38
  39 Table of contents
  40 -----------------
  41
  42 .. toctree::
  43    :maxdepth: 2
  44
  45    intro
  46    theory
  47    using
  48    examples
  49    reference
  50    advanced
  51    license
  52    glossary
  53    bibliography
  54
  55 Indices and tables
  56 ------------------
  57
  58 * :ref:`genindex`
  59 * :ref:`search`
  60
  61 .. * :ref:`section_glossary`