From 93dd3c04e8af5822ff8dcffabbe1ae271788d2cf Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Wed, 19 Jun 2024 08:32:12 +0200 Subject: [PATCH] Minor documentation update and corrections --- src/daSalome/__init__.py | 71 ++++++++++++++++++++++------------------ 1 file changed, 39 insertions(+), 32 deletions(-) diff --git a/src/daSalome/__init__.py b/src/daSalome/__init__.py index c2bcae2..8e9ff45 100644 --- a/src/daSalome/__init__.py +++ b/src/daSalome/__init__.py @@ -24,25 +24,26 @@ __doc__ = """ 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/). +About ADAO: A module for Data Assimilation and Optimization +----------------------------------------------------------- + +**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/ User Documentation dedicated section). Only the use of ADAO text programming interface (API/TUI) is introduced here. This interface gives ability to create a calculation object in a similar way than the case building obtained through the graphical -interface (GUI). When one wants to elaborate "by hand" the TUI +interface (GUI). When one wants to elaborate directly the TUI calculation case, it is recommended to extensively use all the ADAO module documentation, and to go back if necessary to the graphical interface (GUI), to get all the elements allowing to correctly set the @@ -59,13 +60,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 @@ -77,11 +78,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 ------------------------ @@ -109,14 +113,17 @@ 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, + * *ADAO, a module for Data Assimilation and Optimization*, http://www.salome-platform.org/ - * SALOME The Open Source Integration Platform for Numerical Simulation, + * *ADAO, un module pour l'Assimilation de Données et l'Aide à + l'Optimisation*, http://www.salome-platform.org/ + + * *SALOME The Open Source Integration Platform for Numerical Simulation*, http://www.salome-platform.org/ The documentation of the module is also covered by the license and the -- 2.39.2