doc/en/index.rst

   1 ..
   2    Copyright (C) 2008-2015 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 for this module is divided into several major categories,
  47 related to the theoretical documentation (indicated in the title by **[DocT]**),
  48 to the user documentation (indicated in the title by **[DocU]**), and to the
  49 reference documentation (indicated in the title by **[DocR]**). The second part
  50 introduces :ref:`section_theory`, and their concepts. The third part describes
  51 :ref:`section_using`, and the fourth part gives examples on ADAO usage as
  52 :ref:`section_examples`. Users interested in quick use of the module can stop
  53 before reading the rest, but a valuable use of the module requires to read and
  54 come back regularly to the third and seventh parts. The fifth and sixth parts
  55 indicate :ref:`section_advanced`, with obtaining additional information or the
  56 use of non-GUI execution scripting, and a :ref:`section_tui` of the module. The
  57 seventh part gives a detailed :ref:`section_reference`, with three main
  58 sub-parts following. And, to respect the module requirements, be sure to read
  59 the part :ref:`section_license`.
  60
  61 In all this documentation, we use standard notations of linear algebra, data
  62 assimilation (as described in [Ide97]_) and optimization. In particular, vectors
  63 are written horizontally or vertically without making difference. Matrices are
  64 written either normally, or with a condensed notation, consisting in the use of
  65 a space to separate values and a "``;``" to separate the rows, in a continuous
  66 line.
  67
  68 Table of contents
  69 -----------------
  70
  71 .. toctree::
  72    :maxdepth: 2
  73
  74    intro
  75    theory
  76    using
  77    examples
  78    advanced
  79    tui
  80    reference
  81    license
  82    glossary
  83    bibliography
  84
  85 Indices and tables
  86 ------------------
  87
  88 * :ref:`genindex`
  89 * :ref:`search`
  90
  91 .. * :ref:`section_glossary`