doc/en/index.rst

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