doc/index.rst

   1
   2 ================================================================================
   3 ADAO module documentation
   4 ================================================================================
   5
   6 The ADAO module provides **data assimilation** features [#]_ in SALOME context.
   7 It is based on an extensible generic underlying data assimilation library, and
   8 on usage on other SALOME modules, namely YACS and EFICAS.
   9
  10 Briefly stated, Data Assimilation is a methodological framework to compute the
  11 optimal estimate of the inaccesible 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.
  16
  17 The documentation of this module is divided in 4 parts, the first one being an
  18 introduction. The second part describes how to use the module ADAO. The third
  19 part focuses on advanced usages of the module, how to get more information, or
  20 how to use it without the graphical user interface (GUI). The last part gives
  21 examples on ADAO usage.
  22
  23 Users interested in quick use of the module can jump to the last part, but a
  24 valuable use of the module requires to read and come back regularly the second
  25 part.
  26
  27 In all this documentation, we use standard notations of data assimilation.
  28 Vectors are written horizontally or vertically without difference. Matrices are
  29 written either normally, either with a condensed notation, consisting in the
  30 use of a "``;``" to separate the rows in a continuous line.
  31
  32 .. toctree::
  33    :maxdepth: 2
  34
  35    intro
  36    using
  37    advanced
  38    examples
  39
  40 Indices and tables
  41 ================================================================================
  42
  43 * :ref:`genindex`
  44 * :ref:`search`
  45
  46 .. _ECMWF: http://www.ecmwf.int/newsevents/training/rcourse_notes/DATA_ASSIMILATION/ASSIM_CONCEPTS/Assim_concepts.html
  47 .. _Wikipedia/Data_assimilation: http://en.wikipedia.org/wiki/Data_assimilation
  48
  49 .. [#] If you are not familiar with data assimilation concepts in general, an introductory on-line training course can be found at ECMWF_, along with other materials coming from geosciences applications. See also for example `Wikipedia/Data_assimilation`_. Note that data assimilation is not restricted to meteorology or geosciences, but is widely used in other scientific domains.