doc/en/index.rst

   1 ..
   2    Copyright (C) 2008-2021 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. The ADAO module currently offers
  44 more than 100 different algorithmic methods and allows the study of about 350
  45 distinct applied problems. 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 section title by
  50 **[DocT]**), to the user documentation (indicated in the section title by
  51 **[DocU]**), and to the reference documentation (indicated in the section title
  52 by **[DocR]**).
  53
  54 The first part is the :ref:`section_intro`. The second part introduces
  55 :ref:`section_theory`, and their concepts, and the next part describes the
  56 :ref:`section_methodology`. For a standard user, the next parts describe
  57 examples on ADAO usage as :ref:`section_tutorials_in_salome` or
  58 :ref:`section_tutorials_in_python`, then indicates the :ref:`section_advanced`,
  59 with how to obtain additional information or how to use non-GUI command
  60 execution scripting. Users interested in quick use of the module can stop
  61 before reading the rest, but a valuable use of the module requires to read and
  62 come back regularly to these parts. The following parts describe
  63 :ref:`section_gui_in_salome` and :ref:`section_tui`. The last main part gives a
  64 detailed :ref:`section_reference`, with three essential main sub-parts
  65 describing the details of commands and options of the algorithms. A
  66 :ref:`section_glossary`, some :ref:`section_notations`, a
  67 :ref:`section_bibliography` and an extensive index are included in
  68 the document. And, to comply with the module requirements, be sure to read the
  69 part :ref:`section_license`.
  70
  71 .. toctree::
  72    :caption: Table of contents
  73    :name: mastertoc
  74    :maxdepth: 2
  75    :numbered: 2
  76
  77    intro
  78    theory
  79    methodology
  80    tutorials_in_salome
  81    tutorials_in_python
  82    advanced
  83    gui_in_salome
  84    tui
  85    reference
  86    license
  87    bibliography
  88    notations
  89    glossary
  90    genindex
  91
  92 * :ref:`search`