doc/en/index.rst

   1 ..
   2    Copyright (C) 2008-2014 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. _section_home:
  25
  26 ================================================================================
  27 ADAO documentation
  28 ================================================================================
  29
  30 .. image:: images/ADAO_logo.png
  31    :align: center
  32    :width: 20%
  33
  34 The ADAO module provides **data assimilation and optimization** features in
  35 SALOME context. It is based on usage of other SALOME modules, namely YACS and
  36 EFICAS, and on usage of a generic underlying data assimilation library.
  37
  38 Briefly stated, Data Assimilation is a methodological framework to compute the
  39 optimal estimate of the inaccessible true value of a system state over time. It
  40 uses information coming from experimental measurements or observations, and from
  41 numerical *a priori* models, including information about their errors. Parts of
  42 the framework are also known under the names of *parameter estimation*, *inverse
  43 problems*, *Bayesian estimation*, *optimal interpolation*, etc. More details can
  44 be found in the section :ref:`section_theory`.
  45
  46 The documentation of this module is divided in parts. The first one is an
  47 :ref:`section_intro`. The second part introduces :ref:`section_theory`, and
  48 their concepts. The third part describes :ref:`section_using`. The fourth part
  49 gives examples on ADAO usage as :ref:`section_examples`. The fifth part gives a
  50 detailed :ref:`section_reference`. Users interested in quick use of the module
  51 can stop reading before this fifth part, but a valuable use of the module
  52 requires to read and come back regularly to the third and fifth ones. The last
  53 part focuses on :ref:`section_advanced`, how to get more information, or how to
  54 use it by scripting, without the graphical user interface (GUI). And, to respect
  55 the module requirements, be sure to read the part :ref:`section_license`.
  56
  57 In all this documentation, we use standard notations of linear algebra, data
  58 assimilation (as described in [Ide97]_) and optimization. In particular, vectors
  59 are written horizontally or vertically without making difference. Matrices are
  60 written either normally, or with a condensed notation, consisting in the use of
  61 a space to separate values and a "``;``" to separate the rows, in a continuous
  62 line.
  63
  64 Table of contents
  65 -----------------
  66
  67 .. toctree::
  68    :maxdepth: 2
  69
  70    intro
  71    theory
  72    using
  73    examples
  74    advanced
  75    reference
  76    license
  77    glossary
  78    bibliography
  79
  80 Indices and tables
  81 ------------------
  82
  83 * :ref:`genindex`
  84 * :ref:`search`
  85
  86 .. * :ref:`section_glossary`