doc/en/index.rst

   1 ..
   2    Copyright (C) 2008-2019 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]_.
  36
  37 Briefly stated, Data Assimilation is a methodological framework to compute the
  38 optimal estimate of the inaccessible true value of a system state, eventually
  39 over time. It uses information coming from experimental measurements or
  40 observations, and from numerical *a priori* models, including information about
  41 their errors. Parts of the framework are also known under the names of
  42 *parameter estimation*, *inverse problems*, *Bayesian estimation*, *optimal
  43 interpolation*, *field reconstruction*, etc. More details can be found in the
  44 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 section title by
  48 **[DocT]**), to the user documentation (indicated in the section title by
  49 **[DocU]**), and to the reference documentation (indicated in the section title
  50 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 the
  54 :ref:`section_methodology`. For a standard user, the next parts describe
  55 examples on ADAO usage as :ref:`section_tutorials_in_salome` or
  56 :ref:`section_tutorials_in_python`, then indicates the :ref:`section_advanced`,
  57 with how to obtain additional information or how to use non-GUI command
  58 execution scripting. Users interested in quick use of the module can stop
  59 before reading the rest, but a valuable use of the module requires to read and
  60 come back regularly to these parts. The following parts describe
  61 :ref:`section_gui_in_salome` and :ref:`section_tui`. The last main part gives a
  62 detailed :ref:`section_reference`, with three essential main sub-parts
  63 describing the details of commands and options of the algorithms. And, to
  64 comply with the module requirements, be sure to read the part
  65 :ref:`section_license`.
  66
  67 In all this documentation, we use standard notations of linear algebra, data
  68 assimilation (as described in [Ide97]_) and optimization. In particular, vectors
  69 are written horizontally or vertically without making difference. Matrices are
  70 written either normally, or with a condensed notation, consisting in the use of
  71 a space to separate values and a "``;``" to separate the rows, in a continuous
  72 line.
  73
  74 **Table of contents**
  75
  76 .. toctree::
  77    :maxdepth: 2
  78
  79    intro
  80    theory
  81    methodology
  82    tutorials_in_salome
  83    tutorials_in_python
  84    advanced
  85    gui_in_salome
  86    tui
  87    reference
  88    license
  89    glossary
  90    bibliography
  91
  92 **Indices and tables**
  93
  94 * :ref:`genindex`
  95 * :ref:`search`
  96
  97 .. * :ref:`section_glossary`