From: Jean-Philippe ARGAUD Date: Sat, 7 Apr 2018 20:37:16 +0000 (+0200) Subject: Minor correction for GIT and documentation X-Git-Tag: V8_5_0rc1~4 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=e76e91a3b1233409289dc4052785f83ce54597b7;p=modules%2Fadao.git Minor correction for GIT and documentation --- diff --git a/.gitignore b/.gitignore index 24a8a2b..e63f699 100644 --- a/.gitignore +++ b/.gitignore @@ -29,7 +29,6 @@ bin/Makefile.in bin/module_version.pyc checkout.log configure -COPYING doc/Makefile.in examples/daSalome/Makefile.in examples/Makefile.in diff --git a/doc/en/license.rst b/doc/en/license.rst index e1a2520..3582fe9 100644 --- a/doc/en/license.rst +++ b/doc/en/license.rst @@ -58,10 +58,10 @@ 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: - * *ADAO, a SALOME module for Data Assimilation and Optimization*, + * *ADAO, a module for Data Assimilation and Optimization*, http://www.salome-platform.org/ - * *ADAO, un module SALOME pour l'Assimilation de Données et l'Aide à + * *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*, diff --git a/doc/fr/license.rst b/doc/fr/license.rst index 4dc0d70..efce1fd 100644 --- a/doc/fr/license.rst +++ b/doc/fr/license.rst @@ -58,10 +58,10 @@ En outre, on demande que toute publication ou présentation décrivant des trava utilisant ce module, ou tout produit commercial ou non l'utilisant, cite au moins l'une des références ci-dessous : - * *ADAO, a SALOME module for Data Assimilation and Optimization*, + * *ADAO, a module for Data Assimilation and Optimization*, http://www.salome-platform.org/ - * *ADAO, un module SALOME pour l'Assimilation de Données et l'Aide à + * *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*, diff --git a/src/daComposant/daCore/version.py b/src/daComposant/daCore/version.py index e6842e1..7e5bccf 100644 --- a/src/daComposant/daCore/version.py +++ b/src/daComposant/daCore/version.py @@ -27,5 +27,5 @@ __author__ = "Jean-Philippe ARGAUD" __all__ = [] name = "Data Assimilation Package" -version = "2018.03.27" +version = "8.5.0" date = "mardi 27 mars 2018, 12:12:12 (UTC+0100)" diff --git a/src/daSalome/adaoBuilder.py b/src/daSalome/adaoBuilder.py index e2ad3c7..7e3f684 100644 --- a/src/daSalome/adaoBuilder.py +++ b/src/daSalome/adaoBuilder.py @@ -22,6 +22,27 @@ """ Normalized interface for ADAO scripting (full version API) + + The main interface to use is an object "New" build from "adaoBuilder". + + Usage by an example: + + from numpy import array, matrix + 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.execute() + # + print(case.get("Analysis")[-1]) + + Documentation + + See associated up-to-date documentation for details of commands. """ __author__ = "Jean-Philippe ARGAUD" __all__ = ["New"]