doc/en/index.rst

   1 ..
   2    Copyright (C) 2008-2023 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 *calibration*, *adjustment*, *state estimation*, *parameter estimation*,
  43 *parameter adjustment*, *inverse problems*, *inverse methods*, *Bayesian
  44 estimation*, *optimal interpolation*, *mathematical regularization*,
  45 *meta-heuristics for optimization*, *model reduction*, *data smoothing*, etc.
  46 More details can be found in the section :ref:`section_theory`. The ADAO module
  47 currently offers more than one hundred different algorithmic methods and allows
  48 the study of about 350 distinct applied problems.
  49
  50 The documentation for this module is divided into several major categories,
  51 related to the **theoretical documentation** (indicated in the section title by
  52 **[DocT]**), to the **user documentation** (indicated in the section title by
  53 **[DocU]**), and to the **reference documentation** (indicated in the section
  54 title by **[DocR]**).
  55
  56 The first part is the :ref:`section_intro`. The second part introduces
  57 :ref:`section_theory`, and their concepts, and the next part describes the
  58 :ref:`section_methodology`. For a standard user, the next parts describe some
  59 :ref:`section_docu_examples`, quickly accessible by the collection of pointers
  60 to the subsections. Didactic presentations are detailed in
  61 :ref:`section_tutorials_in_salome` or :ref:`section_tutorials_in_python`,
  62 supplemented by information on the :ref:`section_advanced` with how to obtain
  63 additional information or how to use non-GUI command execution scripting.
  64
  65 Users interested in quick access to the module can stop before reading the
  66 remaining parts, but a valuable use of the module requires reading and
  67 returning to these parts regularly. The following parts describe
  68 :ref:`section_gui_in_salome` and :ref:`section_tui`. The last main part gives a
  69 detailed :ref:`section_reference`, with three essential main sub-parts
  70 describing the details of commands and options of the algorithms. A
  71 :ref:`section_glossary`, some :ref:`section_notations`, a
  72 :ref:`section_bibliography`, some elements about :ref:`section_versions`, and
  73 an extensive index are included in the document. And, to comply with the module
  74 requirements, be sure to read the part :ref:`section_license`.
  75
  76 .. toctree::
  77    :caption: Table of contents
  78    :name: mastertoc
  79    :maxdepth: 2
  80    :numbered: 4
  81
  82    intro
  83    theory
  84    methodology
  85    examples
  86    tutorials_in_salome
  87    tutorials_in_python
  88    advanced
  89    gui_in_salome
  90    tui
  91    reference
  92    versions
  93    notations
  94    license
  95    bibliography
  96    glossary
  97    genindex
  98
  99 * :ref:`search`