doc/en/examples.rst

   1 ..
   2    Copyright (C) 2008-2024 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_docu_examples:
  25
  26 ================================================================================
  27 **[DocU]** Examples of ADAO use
  28 ================================================================================
  29
  30 To make reading or searching easier, this section gathers in a synthetic way
  31 the direct pointers, to the appropriate sections, of simple examples of use of
  32 the module (mainly but not only in TUI).
  33
  34 These examples are available in the tutorials, in the detailed documentations
  35 of algorithms or applied problems, and in the advanced uses. They are listed
  36 here by category and alphabetical order.
  37
  38 Tutorials
  39 ---------
  40
  41 #. :ref:`section_tutorials_in_salome`
  42 #. :ref:`section_tutorials_in_python`
  43
  44 Calculation algorithms uses
  45 ---------------------------
  46
  47 #. :ref:`Examples with the "3DVAR" algorithm<section_ref_algorithm_3DVAR_examples>`
  48 #. :ref:`Examples with the "Blue" algorithm<section_ref_algorithm_Blue_examples>`
  49 #. :ref:`Examples with the "DerivativeFreeOptimization" algorithm<section_ref_algorithm_DerivativeFreeOptimization_examples>`
  50 #. :ref:`Examples with the "ExtendedBlue" algorithm<section_ref_algorithm_ExtendedBlue_examples>`
  51 #. :ref:`Examples with the "KalmanFilter" algorithm<section_ref_algorithm_KalmanFilter_examples>`
  52 #. :ref:`Examples with the "NonLinearLeastSquares" algorithm<section_ref_algorithm_NonLinearLeastSquares_examples>`
  53 #. :ref:`Examples with the "ParticleSwarmOptimization" algorithm<section_ref_algorithm_ParticleSwarmOptimization_examples>`
  54
  55 Checking algorithms uses
  56 ------------------------
  57
  58 #. :ref:`Examples with the "AdjointTest" check<section_ref_algorithm_AdjointTest_examples>`
  59 #. :ref:`Examples with the "ControledFunctionTest"<section_ref_algorithm_ControledFunctionTest_examples>`
  60 #. :ref:`Examples with the "FunctionTest" check<section_ref_algorithm_FunctionTest_examples>`
  61 #. :ref:`Examples with the "ObservationSimulationComparisonTest" check<section_ref_algorithm_ObservationSimulationComparisonTest_examples>`
  62 #. :ref:`Examples with the "ParallelFunctionTest" check<section_ref_algorithm_ParallelFunctionTest_examples>`
  63 #. :ref:`Examples with the "ReducedModelingTest" check<section_ref_algorithm_ReducedModelingTest_examples>`
  64
  65 Dedicated tasks or study oriented cases uses
  66 --------------------------------------------
  67
  68 #. :ref:`Examples with the "InterpolationByReducedModelTask" study<section_ref_algorithm_InterpolationByReducedModelTask_examples>`
  69 #. :ref:`Examples with the "MeasurementsOptimalPositioningTask" study<section_ref_algorithm_MeasurementsOptimalPositioningTask_examples>`
  70
  71 Advanced uses
  72 -------------
  73
  74 #. :ref:`section_advanced_convert_JDC`
  75 #. :ref:`section_advanced_YACS_tui`
  76 #. :ref:`section_advanced_R`