doc/en/reference.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_reference:
  25
  26 ================================================================================
  27 **[DocR]** Reference description of the ADAO commands and keywords
  28 ================================================================================
  29
  30 The following sections present the reference description of the ADAO commands
  31 and keywords available through the textual interface (TUI), the graphical
  32 interface (GUI) or through scripts. Two first common sections present the
  33 :ref:`section_reference_entry` and the :ref:`section_reference_special_entry`.
  34 After that, one describes successively the
  35 :ref:`section_reference_assimilation` and the
  36 :ref:`section_reference_checking`.
  37
  38 Each command or keyword to be defined through the ADAO TUI or GUI has some
  39 properties. The first property is to be *required*, *optional* or only factual,
  40 describing a type of input. The second property is to be an "open" variable
  41 with a fixed type but with any value allowed by the type, or a "restricted"
  42 variable, limited to some specified values. The embedded case editor GUI having
  43 build-in validating capacities, the properties of the commands or keywords
  44 given through this interface are automatically correct.
  45
  46 .. _section_reference_entry:
  47
  48 ========================================================================================
  49 **[DocR]** General entries and outputs
  50 ========================================================================================
  51
  52 This section describes in general the different possibilities of entry types and
  53 output variables that can be used. The mathematical notations used afterwards
  54 are explained in the section :ref:`section_theory`.
  55
  56 .. toctree::
  57    :maxdepth: 1
  58
  59    ref_entry_types
  60    ref_options_AlgorithmParameters
  61    ref_output_variables
  62
  63 .. _section_reference_special_entry:
  64
  65 ========================================================================================
  66 **[DocR]** Special entries: functions, matrices, "*observer*"
  67 ========================================================================================
  68
  69 This section describes the special entries, as the functional or matrix forms,
  70 that can be used. The mathematical notations used afterwards are explained in
  71 the section :ref:`section_theory`.
  72
  73 .. toctree::
  74    :maxdepth: 1
  75
  76    ref_operator_requirements
  77    ref_covariance_requirements
  78    ref_observers_requirements
  79
  80 .. _section_reference_assimilation:
  81
  82 ============================================================================================
  83 **[DocR]** Data assimilation or optimization calculation cases
  84 ============================================================================================
  85
  86 This section describes the data assimilation or optimization algorithms
  87 available in ADAO, detailing their usage characteristics and their options.
  88
  89 Some examples on these commands usage are available in the section
  90 :ref:`section_tutorials_in_salome`, in the section
  91 :ref:`section_tutorials_in_python` and in the sample files installed with ADAO.
  92 The mathematical notations used afterward are explained in the section
  93 :ref:`section_theory`.
  94
  95 .. toctree::
  96    :maxdepth: 1
  97
  98    ref_algorithm_3DVAR
  99    ref_algorithm_4DVAR
 100    ref_algorithm_Blue
 101    ref_algorithm_DerivativeFreeOptimization
 102    ref_algorithm_DifferentialEvolution
 103    ref_algorithm_EnsembleBlue
 104    ref_algorithm_EnsembleKalmanFilter
 105    ref_algorithm_ExtendedBlue
 106    ref_algorithm_ExtendedKalmanFilter
 107    ref_algorithm_KalmanFilter
 108    ref_algorithm_LinearLeastSquares
 109    ref_algorithm_NonLinearLeastSquares
 110    ref_algorithm_ParticleSwarmOptimization
 111    ref_algorithm_QuantileRegression
 112    ref_algorithm_TabuSearch
 113    ref_algorithm_UnscentedKalmanFilter
 114    ref_assimilation_keywords
 115
 116 .. _section_reference_checking:
 117
 118 ================================================================================
 119 **[DocR]** Checking cases
 120 ================================================================================
 121
 122 This section describes the checking algorithms available in ADAO, detailing
 123 their usage characteristics and their options.
 124
 125 Some examples on these commands usage are available in the section
 126 :ref:`section_tutorials_in_salome`, in the section
 127 :ref:`section_tutorials_in_python` and in the sample files installed with ADAO.
 128 The mathematical notations used afterward are explained in the section
 129 :ref:`section_theory`.
 130
 131 .. toctree::
 132    :maxdepth: 1
 133
 134    ref_algorithm_AdjointTest
 135    ref_algorithm_FunctionTest
 136    ref_algorithm_GradientTest
 137    ref_algorithm_InputValuesTest
 138    ref_algorithm_LinearityTest
 139    ref_algorithm_LocalSensitivityTest
 140    ref_algorithm_ObserverTest
 141    ref_algorithm_ParallelFunctionTest
 142    ref_algorithm_SamplingTest
 143    ref_algorithm_TangentTest
 144    ref_checking_keywords