From: Jean-Philippe ARGAUD Date: Sat, 19 Mar 2022 20:09:05 +0000 (+0100) Subject: Minor documentation and code review corrections (28) X-Git-Tag: V9_9_0a2~5 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=12c39e84a687e6459ba656fe59051ddde569235f;p=modules%2Fadao.git Minor documentation and code review corrections (28) --- diff --git a/README.txt b/README.txt index b6193e0..da8db1c 100644 --- a/README.txt +++ b/README.txt @@ -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 diff --git a/bin/AdaoCatalogGenerator.py b/bin/AdaoCatalogGenerator.py index cc6c959..2869d62 100644 --- a/bin/AdaoCatalogGenerator.py +++ b/bin/AdaoCatalogGenerator.py @@ -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: diff --git a/doc/en/images/meth_ad_and_opt.png b/doc/en/images/meth_ad_and_opt.png index d101b2f..f9b8958 100644 Binary files a/doc/en/images/meth_ad_and_opt.png and b/doc/en/images/meth_ad_and_opt.png differ diff --git a/doc/en/images/meth_steps_in_study.png b/doc/en/images/meth_steps_in_study.png index 4e4cfac..b457dc0 100644 Binary files a/doc/en/images/meth_steps_in_study.png and b/doc/en/images/meth_steps_in_study.png differ diff --git a/doc/en/images/meth_twin_experiments.png b/doc/en/images/meth_twin_experiments.png index 966a004..e9f3195 100644 Binary files a/doc/en/images/meth_twin_experiments.png and b/doc/en/images/meth_twin_experiments.png differ diff --git a/doc/en/images/ref_observer_simple.png b/doc/en/images/ref_observer_simple.png index a4460a3..4015900 100644 Binary files a/doc/en/images/ref_observer_simple.png and b/doc/en/images/ref_observer_simple.png differ diff --git a/doc/en/images/schema_temporel_KF.png b/doc/en/images/schema_temporel_KF.png index dcfa447..3bd5c9b 100644 Binary files a/doc/en/images/schema_temporel_KF.png and b/doc/en/images/schema_temporel_KF.png differ diff --git a/doc/en/snippets/Variant_3DVAR.rst b/doc/en/snippets/Variant_3DVAR.rst index 8938687..80b826a 100644 --- a/doc/en/snippets/Variant_3DVAR.rst +++ b/doc/en/snippets/Variant_3DVAR.rst @@ -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), diff --git a/doc/fr/images/meth_ad_and_opt.png b/doc/fr/images/meth_ad_and_opt.png index 0d19843..7fc6fdd 100644 Binary files a/doc/fr/images/meth_ad_and_opt.png and b/doc/fr/images/meth_ad_and_opt.png differ diff --git a/doc/fr/images/meth_steps_in_study.png b/doc/fr/images/meth_steps_in_study.png index 1030223..871379c 100644 Binary files a/doc/fr/images/meth_steps_in_study.png and b/doc/fr/images/meth_steps_in_study.png differ diff --git a/doc/fr/images/meth_twin_experiments.png b/doc/fr/images/meth_twin_experiments.png index a5afb9a..79e7272 100644 Binary files a/doc/fr/images/meth_twin_experiments.png and b/doc/fr/images/meth_twin_experiments.png differ diff --git a/doc/fr/images/ref_observer_simple.png b/doc/fr/images/ref_observer_simple.png index a73a6ea..21ae47f 100644 Binary files a/doc/fr/images/ref_observer_simple.png and b/doc/fr/images/ref_observer_simple.png differ diff --git a/doc/fr/images/schema_temporel_KF.png b/doc/fr/images/schema_temporel_KF.png index f1a18b5..339af0a 100644 Binary files a/doc/fr/images/schema_temporel_KF.png and b/doc/fr/images/schema_temporel_KF.png differ diff --git a/doc/fr/snippets/Variant_3DVAR.rst b/doc/fr/snippets/Variant_3DVAR.rst index 88bee1f..84f9fd6 100644 --- a/doc/fr/snippets/Variant_3DVAR.rst +++ b/doc/fr/snippets/Variant_3DVAR.rst @@ -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), diff --git a/src/daComposant/daAlgorithms/3DVAR.py b/src/daComposant/daAlgorithms/3DVAR.py index 50f993e..f8318ca 100644 --- a/src/daComposant/daAlgorithms/3DVAR.py +++ b/src/daComposant/daAlgorithms/3DVAR.py @@ -38,9 +38,9 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): "3DVAR-VAN", "3DVAR-Incr", "3DVAR-PSAS", - "OneCorrection", ], listadv = [ + "OneCorrection", "3DVAR-Std", "Incr3DVAR", ], diff --git a/src/daComposant/daAlgorithms/Blue.py b/src/daComposant/daAlgorithms/Blue.py index 3eb6638..d57f94b 100644 --- a/src/daComposant/daAlgorithms/Blue.py +++ b/src/daComposant/daAlgorithms/Blue.py @@ -35,6 +35,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): message = "Variant ou formulation de la méthode", listval = [ "Blue", + ], + listadv = [ "OneCorrection", ], ) diff --git a/src/daComposant/daAlgorithms/ExtendedBlue.py b/src/daComposant/daAlgorithms/ExtendedBlue.py index 4ec2a13..53dc384 100644 --- a/src/daComposant/daAlgorithms/ExtendedBlue.py +++ b/src/daComposant/daAlgorithms/ExtendedBlue.py @@ -35,6 +35,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): message = "Variant ou formulation de la méthode", listval = [ "ExtendedBlue", + ], + listadv = [ "OneCorrection", ], ) diff --git a/src/daComposant/daAlgorithms/KalmanFilter.py b/src/daComposant/daAlgorithms/KalmanFilter.py index 99b2c4f..9b2da4c 100644 --- a/src/daComposant/daAlgorithms/KalmanFilter.py +++ b/src/daComposant/daAlgorithms/KalmanFilter.py @@ -34,6 +34,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): message = "Variant ou formulation de la méthode", listval = [ "KalmanFilter", + ], + listadv = [ "OneCorrection", ], ) diff --git a/src/daComposant/daAlgorithms/LinearLeastSquares.py b/src/daComposant/daAlgorithms/LinearLeastSquares.py index e4a3f0b..5f4c630 100644 --- a/src/daComposant/daAlgorithms/LinearLeastSquares.py +++ b/src/daComposant/daAlgorithms/LinearLeastSquares.py @@ -34,6 +34,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): message = "Variant ou formulation de la méthode", listval = [ "LinearLeastSquares", + ], + listadv = [ "OneCorrection", ], ) diff --git a/src/daComposant/daAlgorithms/NonLinearLeastSquares.py b/src/daComposant/daAlgorithms/NonLinearLeastSquares.py index 19e5aea..8d5e6d7 100644 --- a/src/daComposant/daAlgorithms/NonLinearLeastSquares.py +++ b/src/daComposant/daAlgorithms/NonLinearLeastSquares.py @@ -35,6 +35,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): message = "Variant ou formulation de la méthode", listval = [ "NonLinearLeastSquares", + ], + listadv = [ "OneCorrection", ], ) diff --git a/src/daComposant/daCore/Aidsm.py b/src/daComposant/daCore/Aidsm.py index 3aa0c20..31e18e3 100644 --- a/src/daComposant/daCore/Aidsm.py +++ b/src/daComposant/daCore/Aidsm.py @@ -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" diff --git a/src/daComposant/daCore/PlatformInfo.py b/src/daComposant/daCore/PlatformInfo.py index e0d484d..013cc0c 100644 --- a/src/daComposant/daCore/PlatformInfo.py +++ b/src/daComposant/daCore/PlatformInfo.py @@ -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 )