doc/en/index.rst

   1 ..
   2    Copyright (C) 2008-2018 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 [Salome]_. It is based on usage of other SALOME modules, namely
  36 YACS and EFICAS, and on usage of a generic underlying data assimilation
  37 library.
  38
  39 Briefly stated, Data Assimilation is a methodological framework to compute the
  40 optimal estimate of the inaccessible true value of a system state over time. It
  41 uses information coming from experimental measurements or observations, and from
  42 numerical *a priori* models, including information about their errors. Parts of
  43 the framework are also known under the names of *parameter estimation*, *inverse
  44 problems*, *Bayesian estimation*, *optimal interpolation*, etc. More details can
  45 be found in the section :ref:`section_theory`.
  46
  47 The documentation for this module is divided into several major categories,
  48 related to the theoretical documentation (indicated in the title by **[DocT]**),
  49 to the user documentation (indicated in the title by **[DocU]**), and to the
  50 reference documentation (indicated in the title by **[DocR]**).
  51
  52 The first part is the :ref:`section_intro`. The second part introduces
  53 :ref:`section_theory`, and their concepts, and the next part describes a
  54 :ref:`section_methodology`. The fourth part describes :ref:`section_using`, and
  55 the fifth part gives examples on ADAO usage as :ref:`section_examples`. Users
  56 interested in quick use of the module can stop before reading the rest, but a
  57 valuable use of the module requires to read and come back regularly to the
  58 fourth and tenth parts. The sixth part indicates the :ref:`section_advanced`,
  59 with how to obtain additional information or how to use non-GUI execution
  60 scripting. The seventh part gives a detailed :ref:`section_reference`, with four
  61 main sub-parts following, the last one giving a :ref:`section_tui` of the
  62 module. And, to respect the module requirements, be sure to read the part
  63 :ref:`section_license`.
  64
  65 In all this documentation, we use standard notations of linear algebra, data
  66 assimilation (as described in [Ide97]_) and optimization. In particular, vectors
  67 are written horizontally or vertically without making difference. Matrices are
  68 written either normally, or with a condensed notation, consisting in the use of
  69 a space to separate values and a "``;``" to separate the rows, in a continuous
  70 line.
  71
  72 Table of contents
  73 -----------------
  74
  75 .. toctree::
  76    :maxdepth: 2
  77
  78    intro
  79    theory
  80    methodology
  81    using
  82    examples
  83    advanced
  84    reference
  85    tui
  86    license
  87    glossary
  88    bibliography
  89
  90 Indices and tables
  91 ------------------
  92
  93 * :ref:`genindex`
  94 * :ref:`search`
  95
  96 .. * :ref:`section_glossary`