]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation and code review corrections (28)
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sat, 19 Mar 2022 20:09:05 +0000 (21:09 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sat, 19 Mar 2022 20:10:18 +0000 (21:10 +0100)
22 files changed:
README.txt
bin/AdaoCatalogGenerator.py
doc/en/images/meth_ad_and_opt.png
doc/en/images/meth_steps_in_study.png
doc/en/images/meth_twin_experiments.png
doc/en/images/ref_observer_simple.png
doc/en/images/schema_temporel_KF.png
doc/en/snippets/Variant_3DVAR.rst
doc/fr/images/meth_ad_and_opt.png
doc/fr/images/meth_steps_in_study.png
doc/fr/images/meth_twin_experiments.png
doc/fr/images/ref_observer_simple.png
doc/fr/images/schema_temporel_KF.png
doc/fr/snippets/Variant_3DVAR.rst
src/daComposant/daAlgorithms/3DVAR.py
src/daComposant/daAlgorithms/Blue.py
src/daComposant/daAlgorithms/ExtendedBlue.py
src/daComposant/daAlgorithms/KalmanFilter.py
src/daComposant/daAlgorithms/LinearLeastSquares.py
src/daComposant/daAlgorithms/NonLinearLeastSquares.py
src/daComposant/daCore/Aidsm.py
src/daComposant/daCore/PlatformInfo.py

index b6193e001b46d410dd7edd13bc2d4c5cd0255b67..da8db1cf7af9a3398fb491d7b25ad2801947e803 100644 (file)
@@ -16,12 +16,12 @@ the framework are also known under the names of *calibration*, *adjustment*,
 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/).
+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
index cc6c9590bba54bbc6f4d52c547d45edae4a4806f..2869d6237f0c35fde25e4549b0d25cdd7b1d59d1 100644 (file)
@@ -431,7 +431,7 @@ check_names = ""
 decl_algos  = ""
 adao_all_names = ""
 assim_study_object = daCore.Aidsm.Aidsm()
-algos_list = assim_study_object.get_available_algorithms()
+algos_list = assim_study_object._Aidsm__get_available_algorithms()
 del assim_study_object
 for algo_name in algos_list:
   if algo_name in infos.AssimAlgos:
index d101b2f1c30dbc1921d4b4b7ad990b441270c588..f9b89589a03f758c4407386964b8db48904d79fe 100644 (file)
Binary files a/doc/en/images/meth_ad_and_opt.png and b/doc/en/images/meth_ad_and_opt.png differ
index 4e4cfacbd186dda58676c1698674016eaf18bb37..b457dc0bc3e11baff764d4ea60040588c0676320 100644 (file)
Binary files a/doc/en/images/meth_steps_in_study.png and b/doc/en/images/meth_steps_in_study.png differ
index 966a0041fdbacd68d67cdb689aa1a5b49f67868b..e9f31957bffa7422bce3c39483a866d95a2afeb8 100644 (file)
Binary files a/doc/en/images/meth_twin_experiments.png and b/doc/en/images/meth_twin_experiments.png differ
index a4460a377eb705bfb1176e17e5aaa9542437edc0..401590024bffbd5f5942e37285f1f1744f1e8f84 100644 (file)
Binary files a/doc/en/images/ref_observer_simple.png and b/doc/en/images/ref_observer_simple.png differ
index dcfa447a7cf26e9e87e5743c3b1fcd238dfd4fd1..3bd5c9b059e1d04b9deeb88d858c2ba914d2b044 100644 (file)
Binary files a/doc/en/images/schema_temporel_KF.png and b/doc/en/images/schema_temporel_KF.png differ
index 8938687158fd41fb030df6dfcef2b261af98354d..80b826a745a3bd7809836843e5b21eab33d03ea3 100644 (file)
@@ -9,7 +9,7 @@ Variant
   *Predifined name*.  This key allows to choose one of the possible variants
   for the main algorithm. The default variant is the original "3DVAR", and the
   possible ones are
-  "3DVAR" (3D Variational analysis),
+  "3DVAR" (Classical 3D Variational analysis),
   "3DVAR-VAN" (3D Variational Analysis with No inversion of B),
   "3DVAR-Incr" (Incremental 3DVAR),
   "3DVAR-PSAS" (Physical-space Statistical Analysis Scheme for 3DVAR),
index 0d198438addc9c1c412a120609f209b0d41e216e..7fc6fddb45b203de083d06c3f3ff1cf004a7125d 100644 (file)
Binary files a/doc/fr/images/meth_ad_and_opt.png and b/doc/fr/images/meth_ad_and_opt.png differ
index 103022327b51dd686186a8b218fa52d4310afac1..871379ca5a9dc08b0d7a7bb8fb79a459a5f517e5 100644 (file)
Binary files a/doc/fr/images/meth_steps_in_study.png and b/doc/fr/images/meth_steps_in_study.png differ
index a5afb9ab74c21b59bbbd9e6683bb78be68b412c8..79e727292a60b33db1df3fd566707e6d13754663 100644 (file)
Binary files a/doc/fr/images/meth_twin_experiments.png and b/doc/fr/images/meth_twin_experiments.png differ
index a73a6eae5aaec03a8474d8393da3bd0706a308d7..21ae47fc466e34a35034d44c53b3dba1f012488a 100644 (file)
Binary files a/doc/fr/images/ref_observer_simple.png and b/doc/fr/images/ref_observer_simple.png differ
index f1a18b5c933b6d8aedc25c0c53ba6c0d186551b8..339af0a6415454eece566cee66e8aefe49b84116 100644 (file)
Binary files a/doc/fr/images/schema_temporel_KF.png and b/doc/fr/images/schema_temporel_KF.png differ
index 88bee1f2070d42962213705d080a98b924df9937..84f9fd6be7dba86f2b8d8af6f81b947a907838fa 100644 (file)
@@ -9,7 +9,7 @@ Variant
   *Nom prédéfini*. Cette clé permet de choisir l'une des variantes possibles
   pour l'algorithme principal. La variante par défaut est le "3DVAR" d'origine,
   et les choix possibles sont
-  "3DVAR" (3D Variational analysis),
+  "3DVAR" (3D Variational analysis classique),
   "3DVAR-VAN" (3D Variational Analysis with No inversion of B),
   "3DVAR-Incr" (Incremental 3DVAR),
   "3DVAR-PSAS" (Physical-space Statistical Analysis Scheme for 3DVAR),
index 50f993e7417c38d6d51ce4943254ce0f8187d28b..f8318ca2a2d88058887a4d79a0b7b2580f688b7c 100644 (file)
@@ -38,9 +38,9 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
                 "3DVAR-VAN",
                 "3DVAR-Incr",
                 "3DVAR-PSAS",
-                "OneCorrection",
                 ],
             listadv  = [
+                "OneCorrection",
                 "3DVAR-Std",
                 "Incr3DVAR",
                 ],
index 3eb663865627f1f92075c57bda62a3837461082b..d57f94bc5e5e8a11ea7ae20a825032086048c923 100644 (file)
@@ -35,6 +35,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             message  = "Variant ou formulation de la méthode",
             listval  = [
                 "Blue",
+                ],
+            listadv  = [
                 "OneCorrection",
                 ],
             )
index 4ec2a13d15843600290432519fed400841557ea8..53dc384c3e275ae2027ed56fe9c9444b8eba3514 100644 (file)
@@ -35,6 +35,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             message  = "Variant ou formulation de la méthode",
             listval  = [
                 "ExtendedBlue",
+                ],
+            listadv  = [
                 "OneCorrection",
                 ],
             )
index 99b2c4f4bd6c77833fed51ab5ef83b464db3b5d1..9b2da4c1c0b2c1bd9bb2ce2d25d4867a54d68d03 100644 (file)
@@ -34,6 +34,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             message  = "Variant ou formulation de la méthode",
             listval  = [
                 "KalmanFilter",
+                ],
+            listadv  = [
                 "OneCorrection",
                 ],
             )
index e4a3f0bc15606b11b03009b7845be12966934895..5f4c6302a338e8c4c8a5234ac1636aa1156f6059 100644 (file)
@@ -34,6 +34,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             message  = "Variant ou formulation de la méthode",
             listval  = [
                 "LinearLeastSquares",
+                ],
+            listadv  = [
                 "OneCorrection",
                 ],
             )
index 19e5aea12f65f741efab40d4141b0c939fc22cff..8d5e6d704040c181cc413a9c17f0458142eb77ac 100644 (file)
@@ -35,6 +35,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm):
             message  = "Variant ou formulation de la méthode",
             listval  = [
                 "NonLinearLeastSquares",
+                ],
+            listadv  = [
                 "OneCorrection",
                 ],
             )
index 3aa0c20e835bb64958b4f7425609d10f8971fa9b..31e18e3c7f0e23bc37bb4304b352c1574c646e60 100644 (file)
@@ -676,7 +676,7 @@ class Aidsm(object):
 
     # -----------------------------------------------------------
 
-    def get_available_variables(self):
+    def __get_available_variables(self):
         """
         Renvoie les variables potentiellement utilisables pour l'étude,
         initialement stockées comme données d'entrées ou dans les algorithmes,
@@ -700,7 +700,7 @@ class Aidsm(object):
             variables.sort()
             return variables
 
-    def get_available_algorithms(self):
+    def __get_available_algorithms(self):
         """
         Renvoie la liste des algorithmes potentiellement utilisables, identifiés
         par les chaînes de caractères.
@@ -720,13 +720,13 @@ class Aidsm(object):
         files.sort()
         return files
 
-    def get_algorithms_main_path(self):
+    def __get_algorithms_main_path(self):
         """
         Renvoie le chemin pour le répertoire principal contenant les algorithmes
         """
         return self.__parent
 
-    def add_algorithms_path(self, Path=None):
+    def __add_algorithms_path(self, Path=None):
         """
         Ajoute au chemin de recherche des algorithmes un répertoire dans lequel
         se trouve un sous-répertoire "daAlgorithms"
index e0d484d4f5c5de267b51ffff510080d6c1bfd0c5..013cc0c0e5803aa5c53d499f4fe8700b57852103 100644 (file)
@@ -373,7 +373,7 @@ class PathManagement(object):
         self.__paths["daNumerics"]  = os.path.join(parent,"daNumerics")
         #
         for v in self.__paths.values():
-            sys.path.insert(0, v )
+            if os.path.isdir(v): sys.path.insert(0, v )
         #
         # Conserve en unique exemplaire chaque chemin
         sys.path = uniq( sys.path )