From 1eea9cae5412d7c519d66ee15681bb9a76c48406 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Tue, 31 Mar 2015 23:18:04 +0200 Subject: [PATCH] Minor documentation and source improvements --- bin/AdaoCatalogGenerator.py | 2 +- doc/en/index.rst | 25 +++++++++------ doc/en/license.rst | 6 ++-- doc/en/ref_algorithm_FunctionTest.rst | 2 +- doc/fr/advanced.rst | 6 ++-- doc/fr/index.rst | 31 +++++++++++-------- doc/fr/license.rst | 6 ++-- doc/fr/ref_algorithm_FunctionTest.rst | 4 +-- src/daComposant/daAlgorithms/FunctionTest.py | 2 +- src/daComposant/daCore/AssimilationStudy.py | 1 + src/daComposant/daCore/BasicObjects.py | 3 +- src/daComposant/daCore/ExtendedLogging.py | 1 + src/daComposant/daCore/Persistence.py | 3 +- src/daComposant/daCore/PlatformInfo.py | 5 +-- .../daYacsIntegration/daOptimizerLoop.py | 4 ++- 15 files changed, 60 insertions(+), 41 deletions(-) diff --git a/bin/AdaoCatalogGenerator.py b/bin/AdaoCatalogGenerator.py index 55ca12c..20a1547 100644 --- a/bin/AdaoCatalogGenerator.py +++ b/bin/AdaoCatalogGenerator.py @@ -417,7 +417,7 @@ for algo in all_names: par_keys.sort() algo_parameters = "" for pn in par_keys: - if pn in ("StoreInternalVariables",): continue + if pn in ("StoreInternalVariables",): continue # Cles a supprimer pt = par_dict[pn]["typecast"] pd = par_dict[pn]["default"] pm = par_dict[pn]["message"] diff --git a/doc/en/index.rst b/doc/en/index.rst index 4e739cd..15a6002 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -43,16 +43,20 @@ 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 section :ref:`section_theory`. -The documentation of this module is divided in parts. The first one is an -:ref:`section_intro`. The second part introduces :ref:`section_theory`, and -their concepts. The third part describes :ref:`section_using`. The fourth part -gives examples on ADAO usage as :ref:`section_examples`. The fifth part gives a -detailed :ref:`section_reference`. Users interested in quick use of the module -can stop reading before this fifth part, but a valuable use of the module -requires to read and come back regularly to the third and fifth ones. The last -part focuses on :ref:`section_advanced`, how to get more information, or how to -use it by scripting, without the graphical user interface (GUI). And, to respect -the module requirements, be sure to read the part :ref:`section_license`. +The documentation for this module is divided into several major categories, +related to the theoretical documentation (indicated in the title by **[DocT]**), +to the user documentation (indicated in the title by **[DocU]**), and to the +reference documentation (indicated in the title by **[DocR]**). The second part +introduces :ref:`section_theory`, and their concepts. The third part describes +:ref:`section_using`, and the fourth part gives examples on ADAO usage as +:ref:`section_examples`. Users interested in quick use of the module can stop +before reading the rest, but a valuable use of the module requires to read and +come back regularly to the third and seventh parts. The fifth and sixth parts +indicate :ref:`section_advanced`, with obtaining additional information or the +use of non-GUI execution scripting, and a :ref:`section_tui` of the module. The +seventh part gives a detailed :ref:`section_reference`, with three main +sub-parts following. And, to respect the module requirements, be sure to read +the part :ref:`section_license`. In all this documentation, we use standard notations of linear algebra, data assimilation (as described in [Ide97]_) and optimization. In particular, vectors @@ -72,6 +76,7 @@ Table of contents using examples advanced + tui reference license glossary diff --git a/doc/en/license.rst b/doc/en/license.rst index 637bae5..cad74cb 100644 --- a/doc/en/license.rst +++ b/doc/en/license.rst @@ -54,9 +54,9 @@ GPL), as stated here and in the source files:: See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com -In addition, we expect that all publications describing work using this -software, or all commercial or not products using it, quote at least one of the -references given below: +In addition, we expect 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*, http://www.salome-platform.org/ diff --git a/doc/en/ref_algorithm_FunctionTest.rst b/doc/en/ref_algorithm_FunctionTest.rst index c16fbf9..e8724be 100644 --- a/doc/en/ref_algorithm_FunctionTest.rst +++ b/doc/en/ref_algorithm_FunctionTest.rst @@ -92,7 +92,7 @@ The options of the algorithm are the following: SetDebug This key requires the activation, or not, of the debug mode during the - function evaluation. The default is "True", the choices are "True" or + function evaluation. The default is "False", the choices are "True" or "False". Example : ``{"SetDebug":False}`` diff --git a/doc/fr/advanced.rst b/doc/fr/advanced.rst index fb14ecd..7ca118a 100644 --- a/doc/fr/advanced.rst +++ b/doc/fr/advanced.rst @@ -30,7 +30,7 @@ Cette section présente des méthodes avancées d'usage du module ADAO, comment obtenir plus d'information lors d'un calcul, ou comment l'utiliser sans l'interface graphique (GUI). Cela nécessite de savoir comment trouver les -fichiers ou les commandes incuses dans l'installation complète de SALOME. Tous +fichiers ou les commandes incluses dans l'installation complète de SALOME. Tous les noms à remplacer par l'utilisateur sont indiqués par la syntaxe ``<...>``. Convertir et exécuter un fichier de commandes ADAO (JDC) par l'intermédiaire d'un script shell @@ -258,7 +258,9 @@ parall cas, vérifiez bien votre fonction d'opérateur avant et pendant l'activation du parallélisme... -**En cas de doute, il est recommandé de NE PAS ACTIVER ce parallélisme.** +.. warning:: + + en cas de doute, il est recommandé de NE PAS ACTIVER ce parallélisme. Passer d'une version d'ADAO à une nouvelle ------------------------------------------ diff --git a/doc/fr/index.rst b/doc/fr/index.rst index 887eea5..8150580 100644 --- a/doc/fr/index.rst +++ b/doc/fr/index.rst @@ -46,19 +46,23 @@ cadre sont etc. De plus amples détails peuvent être trouvés dans la partie :ref:`section_theory`. -La documentation de ce module est divisée en plusieurs parties. La première est -une :ref:`section_intro`. La seconde partie présente :ref:`section_theory`, et à -leurs concepts. La troisième partie explique comment :ref:`section_using`. La -quatrième partie présente des exemples d'utilisation sous la forme de -:ref:`section_examples`. La cinquième partie détaille la -:ref:`section_reference`. Les utilisateurs intéressés par un accès rapide au -module peuvent s'arrêter avant la lecture de cette partie, mais un usage utile -du module nécessite de lire et de revenir régulièrement aux troisième et -cinquième parties. La dernière partie se focalise sur des -:ref:`section_advanced`, sur l'obtention de renseignements supplémentaires, ou -sur l'usage par scripts, sans interface utilisateur graphique (GUI). Enfin, pour -respecter les exigences de licence du module, n'oubliez pas de lire la partie -:ref:`section_license`. +La documentation de ce module est divisée en plusieurs grandes catégories, +relatives à la documentation théorique (indiquée dans le titre par **[DocT]**), +à la documentation utilisateur (indiquée dans le titre par **[DocU]**), et à la +documentation de référence (indiquée dans le titre par **[DocR]**). La seconde +partie présente :ref:`section_theory`, et à leurs concepts. Pour un utilisateur, +la troisième partie explique comment :ref:`section_using`, et la quatrième +partie présente des exemples d'utilisation sous la forme de +:ref:`section_examples`. Les utilisateurs intéressés par un accès rapide au +module peuvent s'arrêter avant la lecture de la suite, mais un usage utile du +module nécessite de lire et de revenir régulièrement aux troisième et septième +parties. Les cinquième et la sixième parties indiquent les +:ref:`section_advanced`, avec l'obtention de renseignements supplémentaires ou +l'usage par scripts d'exécution sans interface utilisateur graphique (GUI), et +une :ref:`section_tui` du module. La septième partie détaille la +:ref:`section_reference`, avec trois sous-parties principales qui suivent. +Enfin, pour respecter les exigences de licence du module, n'oubliez pas de lire +la partie :ref:`section_license`. Dans cette documentation, on utilise les notations standards de l'algèbre linéaire, de l'assimilation de données (comme décrit dans [Ide97]_) et de @@ -79,6 +83,7 @@ Table des mati using examples advanced + tui reference license glossary diff --git a/doc/fr/license.rst b/doc/fr/license.rst index 6def81d..23653b9 100644 --- a/doc/fr/license.rst +++ b/doc/fr/license.rst @@ -54,9 +54,9 @@ tel qu'il est d See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com -En outre, nous souhaitons que toute publication décrivant des travaux utilisant -ce module, ou tout produit commercial ou non l'utilisant, cite au moins l'une -des références ci-dessous : +En outre, nous souhaitons que toute publication ou présentation décrivant des +travaux 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*, http://www.salome-platform.org/ diff --git a/doc/fr/ref_algorithm_FunctionTest.rst b/doc/fr/ref_algorithm_FunctionTest.rst index 587ba40..9a0abc4 100644 --- a/doc/fr/ref_algorithm_FunctionTest.rst +++ b/doc/fr/ref_algorithm_FunctionTest.rst @@ -95,8 +95,8 @@ Les options de l'algorithme sont les suivantes: SetDebug Cette clé requiert l'activation, ou pas, du mode de débogage durant - l'évaluation de la fonction. La valeur par défaut est "True", les choix sont - "True" ou "False". + l'évaluation de la fonction. La valeur par défaut est "False", les choix + sont "True" ou "False". Exemple : ``{"SetDebug":False}`` diff --git a/src/daComposant/daAlgorithms/FunctionTest.py b/src/daComposant/daAlgorithms/FunctionTest.py index 7adfd4e..6a577d6 100644 --- a/src/daComposant/daAlgorithms/FunctionTest.py +++ b/src/daComposant/daAlgorithms/FunctionTest.py @@ -50,7 +50,7 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): ) self.defineRequiredParameter( name = "SetDebug", - default = True, + default = False, typecast = bool, message = "Activation du mode debug lors de l'exécution", ) diff --git a/src/daComposant/daCore/AssimilationStudy.py b/src/daComposant/daCore/AssimilationStudy.py index b0f79e2..e063fd7 100644 --- a/src/daComposant/daCore/AssimilationStudy.py +++ b/src/daComposant/daCore/AssimilationStudy.py @@ -28,6 +28,7 @@ les objets élémentaires de l'étude. """ __author__ = "Jean-Philippe ARGAUD" +__all__ = ["AssimilationStudy"] import os, sys import numpy diff --git a/src/daComposant/daCore/BasicObjects.py b/src/daComposant/daCore/BasicObjects.py index 0e83daa..f803520 100644 --- a/src/daComposant/daCore/BasicObjects.py +++ b/src/daComposant/daCore/BasicObjects.py @@ -27,6 +27,7 @@ les objets élémentaires de l'algorithme. """ __author__ = "Jean-Philippe ARGAUD" +__all__ = [] import logging, copy import numpy @@ -497,7 +498,7 @@ class Covariance: self.size = 0 elif asEyeByVector is not None: self.__is_vector = True - self.__C = numpy.abs( numpy.array( numpy.ravel( asEyeByVector ), float ) ) + self.__C = numpy.abs( numpy.array( numpy.ravel( numpy.matrix(asEyeByVector, float ) ) ) ) self.shape = (self.__C.size,self.__C.size) self.size = self.__C.size**2 elif asCovariance is not None: diff --git a/src/daComposant/daCore/ExtendedLogging.py b/src/daComposant/daCore/ExtendedLogging.py index a945e9b..a7beee9 100644 --- a/src/daComposant/daCore/ExtendedLogging.py +++ b/src/daComposant/daCore/ExtendedLogging.py @@ -71,6 +71,7 @@ NOTSET=0 < DEBUG=10 < INFO=20 < WARNING=30 < ERROR=40 < CRITICAL=50 """ __author__ = "Jean-Philippe ARGAUD" +__all__ = [] import os import sys diff --git a/src/daComposant/daCore/Persistence.py b/src/daComposant/daCore/Persistence.py index d642d47..0bf1b4d 100644 --- a/src/daComposant/daCore/Persistence.py +++ b/src/daComposant/daCore/Persistence.py @@ -20,11 +20,12 @@ # # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D -__doc__ = """ +""" Définit des outils de persistence et d'enregistrement de séries de valeurs pour analyse ultérieure ou utilisation de calcul. """ __author__ = "Jean-Philippe ARGAUD" +__all__ = [] import numpy, copy diff --git a/src/daComposant/daCore/PlatformInfo.py b/src/daComposant/daCore/PlatformInfo.py index b61ab1e..4d2124c 100644 --- a/src/daComposant/daCore/PlatformInfo.py +++ b/src/daComposant/daCore/PlatformInfo.py @@ -20,9 +20,9 @@ # # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D -__doc__ = """ +""" Informations sur le code et la plateforme, et mise à jour des chemins - + La classe "PlatformInfo" permet de récupérer les informations générales sur le code et la plateforme sous forme de strings, ou d'afficher directement les informations disponibles par les méthodes. L'impression directe d'un @@ -37,6 +37,7 @@ __doc__ = """ PathManagement() """ __author__ = "Jean-Philippe ARGAUD" +__all__ = [] import os diff --git a/src/daSalome/daYacsIntegration/daOptimizerLoop.py b/src/daSalome/daYacsIntegration/daOptimizerLoop.py index ef1ddee..2e40cce 100644 --- a/src/daSalome/daYacsIntegration/daOptimizerLoop.py +++ b/src/daSalome/daYacsIntegration/daOptimizerLoop.py @@ -347,7 +347,9 @@ class AssimilationAlgorithm_asynch(SALOMERuntime.OptimizerAlgASync): try: self.ADD.analyze() except Exception as e: - raise ValueError("during analyse, the following error occurs:\n\n%s\n\nSee also the potential messages, which can show the origin of the above error, in the YACS GUI or in the launching terminal."%(str(e),)) + if type(e) == type(SyntaxError()): msg = "at %s: %s"%(e.offset, e.text) + else: msg = "" + raise ValueError("during analyse, the following error occurs:\n\n%s %s\n\nSee also the potential messages, which can show the origin of the above error, in the YACS GUI or in the launching terminal."%(str(e),msg)) # Assimilation Study is finished self.pool.destroyAll() -- 2.39.2