Salome HOME
Code improvements, review and simplifications (2)
[modules/adao.git] / README.txt
index 07caa301edadbd21ad5e063ab61583a6e8294bfa..b6193e001b46d410dd7edd13bc2d4c5cd0255b67 100644 (file)
@@ -5,17 +5,18 @@ ADAO: A module for Data Assimilation and Optimization
 About
 -----
 
-**The ADAO module provides data assimilation and optimization**
-features in Python or SALOME context (see
-http://www.salome-platform.org/). Briefly stated, Data Assimilation is
-a methodological framework to compute the optimal estimate of the
-inaccessible true value of a system state, eventually over time. It
-uses information coming from experimental measurements or observations,
-and from numerical *a priori* models, including information about their
-errors. Parts of the framework are also known under the names of
-*parameter estimation*, *inverse problems*, *Bayesian estimation*,
-*optimal interpolation*, etc. More details can be found in the full
-ADAO documentation (see http://www.salome-platform.org/).
+**The ADAO module provides data assimilation and optimization** features in
+Python or SALOME context (see http://www.salome-platform.org/). Briefly stated,
+Data Assimilation is a methodological framework to compute the optimal estimate
+of the inaccessible true value of a system state, eventually over time. It uses
+information coming from experimental measurements or observations, and from
+numerical *a priori* models, including information about their errors. Parts of
+the framework are also known under the names of *calibration*, *adjustment*,
+*state estimation*, *parameter estimation*, *parameter adjustment*, *inverse
+problems*, *Bayesian estimation*, *optimal interpolation*, *mathematical
+regularization*, *meta-heuristics for optimization*, *model reduction*, *data
+smoothing*, etc. More details can be found in the full ADAO documentation (see
+https://www.salome-platform.org/).
 
 Only the use of ADAO text programming interface (API/TUI) is introduced
 here. This interface gives ability to create a calculation object in a
@@ -37,13 +38,13 @@ commands is the following one::
     from numpy import array, matrix
     from adao import adaoBuilder
     case = adaoBuilder.New()
-    case.set( 'AlgorithmParameters', Algorithm='3DVAR' )
-    case.set( 'Background',          Vector=[0, 1, 2] )
-    case.set( 'BackgroundError',     ScalarSparseMatrix=1.0 )
-    case.set( 'Observation',         Vector=array([0.5, 1.5, 2.5]) )
-    case.set( 'ObservationError',    DiagonalSparseMatrix='1 1 1' )
-    case.set( 'ObservationOperator', Matrix='1 0 0;0 2 0;0 0 3' )
-    case.set( 'Observer',            Variable="Analysis", Template="ValuePrinter" )
+    case.set( 'AlgorithmParameters', Algorithm = '3DVAR' )
+    case.set( 'Background',          Vector = [0, 1, 2] )
+    case.set( 'BackgroundError',     ScalarSparseMatrix = 1.0 )
+    case.set( 'Observation',         Vector = array([0.5, 1.5, 2.5]) )
+    case.set( 'ObservationError',    DiagonalSparseMatrix = '1 1 1' )
+    case.set( 'ObservationOperator', Matrix = '1 0 0;0 2 0;0 0 3' )
+    case.set( 'Observer',            Variable = "Analysis", Template = "ValuePrinter" )
     case.execute()
 
 The result of running these commands in SALOME (either as a SALOME
@@ -55,11 +56,14 @@ the script execution entry of the menu) is the following::
 More advanced examples of ADAO TUI calculation case
 ---------------------------------------------------
 
-Real cases involves observations loaded from files, operators
-explicitly defined as generic functions including physical simulators,
-time dependant information in order to deal with forecast analysis in
-addition to calibration or re-analysis. More details can be found in
-the full ADAO documentation (see http://www.salome-platform.org/).
+Real cases involve observations loaded from files, operators explicitly
+defined as generic functions including physical simulators, time dependant
+information in order to deal with forecast analysis in addition to calibration
+or re-analysis. More details can be found in the full ADAO documentation (see
+documentation on the reference site https://www.salome-platform.org/, with
+https://docs.salome-platform.org/latest/gui/ADAO/en/index.html for english or
+https://docs.salome-platform.org/latest/gui/ADAO/fr/index.html for french, both
+being equivalents).
 
 License and requirements
 ------------------------
@@ -69,7 +73,7 @@ The license for this module is the GNU Lesser General Public License
 
     <ADAO, a module for Data Assimilation and Optimization>
 
-    Copyright (C) 2008-2021 EDF R&D
+    Copyright (C) 2008-2022 EDF R&D
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
@@ -87,9 +91,9 @@ The license for this module is the GNU Lesser General Public License
 
     See http://www.salome-platform.org/
 
-In addition, we require that all publication or presentation describing
-work using this software, or all commercial or not products using it,
-quote at least one of the references given below:
+In addition, it is requested that any publication or presentation, describing
+work using this module, or any commercial or non-commercial product using it,
+cite at least one of the references below with the current year added:
 
     * *ADAO, a module for Data Assimilation and Optimization*,
       http://www.salome-platform.org/