]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor correction for GIT and documentation
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sat, 7 Apr 2018 20:37:16 +0000 (22:37 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Mon, 9 Apr 2018 07:34:22 +0000 (09:34 +0200)
.gitignore
doc/en/license.rst
doc/fr/license.rst
src/daComposant/daCore/version.py
src/daSalome/adaoBuilder.py

index 24a8a2b98e9d257decc6cfdc13fa06a7196ad820..e63f699659d2d8c9189bb49ca94b5f6c8a4d37f1 100644 (file)
@@ -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
index e1a2520a284477f01b50f31a80dc7d36bb95838f..3582fe92573de1cdac49a52729559f647a7bd15b 100644 (file)
@@ -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*,
index 4dc0d70f539ec40ed728f3dc3f63c20f6466b684..efce1fd004dd98d0eb660fca114ed63f4b463c69 100644 (file)
@@ -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*,
index e6842e11f5d6f51f6d15aff3617579ee25e8fa95..7e5bccfd40ea83e17d7b6c3a7dc28b48846bf542 100644 (file)
@@ -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)"
index e2ad3c763ead5382f78ec4c07e62fb1ee6e3f4a5..7e3f684fdee40c24046fecaf58fded588ca82753 100644 (file)
 
 """
     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"]