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