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 on 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 focuses on
  21 advanced usages of the module, how to get more information, or how to use it
  22 without the graphical user interface (GUI). The last part gives examples on ADAO
  23 usage. Users interested in quick use of the module can jump to the section
  24 :ref:`section_examples`, but a valuable use of the module requires to read and
  25 come back regularly the section :ref:`section_using`.
  26
  27 In all this documentation, we use standard notations of data assimilation.
  28 Moreover, vectors are written horizontally or vertically without difference.
  29 Matrices are written either normally, either with a condensed notation,
  30 consisting in the use of a "``;``" to separate the rows in a continuous line.
  31
  32 .. toctree::
  33    :maxdepth: 2
  34
  35    intro
  36    theory
  37    using
  38    advanced
  39    examples
  40
  41 Indices and tables
  42 ================================================================================
  43
  44 * :ref:`genindex`
  45 * :ref:`search`