]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Minor documentation and source improvements
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Tue, 31 Mar 2015 21:18:04 +0000 (23:18 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Tue, 31 Mar 2015 21:18:04 +0000 (23:18 +0200)
15 files changed:
bin/AdaoCatalogGenerator.py
doc/en/index.rst
doc/en/license.rst
doc/en/ref_algorithm_FunctionTest.rst
doc/fr/advanced.rst
doc/fr/index.rst
doc/fr/license.rst
doc/fr/ref_algorithm_FunctionTest.rst
src/daComposant/daAlgorithms/FunctionTest.py
src/daComposant/daCore/AssimilationStudy.py
src/daComposant/daCore/BasicObjects.py
src/daComposant/daCore/ExtendedLogging.py
src/daComposant/daCore/Persistence.py
src/daComposant/daCore/PlatformInfo.py
src/daSalome/daYacsIntegration/daOptimizerLoop.py

index 55ca12cd43f8cbde77edc912ac94337dec46bb60..20a1547a48943bec0cef7c851a9a1d5f08fcedef 100644 (file)
@@ -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"]
index 4e739cdef127675cd8b15a9950075fdfabc166ef..15a60020cceff688924db2d302ebf2f27ddef306 100644 (file)
@@ -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
index 637bae53affa8f528e892042c447057703c17a76..cad74cbb19b9c53118b1f61e8539258a11393ee5 100644 (file)
@@ -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/
index c16fbf97914620d64da3c2d660c231749ffe0861..e8724bef0eb338305b66fbf12925952ff0fec5fe 100644 (file)
@@ -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}``
index fb14ecd6e7d9bc2bd5e607602187e5a550b70822..7ca118ab819e6f86ca5b8a8a5ece9a97e00e3ba4 100644 (file)
@@ -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
 ------------------------------------------
index 887eea5daae37b3189559a0673571ea9541382c5..8150580f6b97d651691892f93cb315d121f02845 100644 (file)
@@ -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
index 6def81d75966ef65abda85c27bb46db1fa0bccac..23653b976ac71719d0d7a6fdf15c59fd27cbd6cb 100644 (file)
@@ -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/
index 587ba40c04b213a5529860cce1ab87b3cbef6066..9a0abc4aa17e3df27cc009f22bcf50d250a0aea3 100644 (file)
@@ -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}``
 
index 7adfd4e2618f713deed9ec085690f088884d3d4c..6a577d6d75764345995e7e8cd8f997ec1c69a53b 100644 (file)
@@ -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",
             )
index b0f79e21c708121780427a130984efb2aa31dba3..e063fd7fff6f8b997ec29dcf2f92bda82df2f60f 100644 (file)
@@ -28,6 +28,7 @@
     les objets élémentaires de l'étude.
 """
 __author__ = "Jean-Philippe ARGAUD"
+__all__ = ["AssimilationStudy"]
 
 import os, sys
 import numpy
index 0e83daa7e794a38d2e26badc08d6c84906e1ce12..f803520adde3a7616b6faf3c58fa5abe20110a5a 100644 (file)
@@ -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:
index a945e9b62b60e05593032465406ad8114c7370a1..a7beee9fe021815219742cc66134669d57534609 100644 (file)
@@ -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
index d642d47fad03ad22144f120bee74ca3c947077d6..0bf1b4d6ebedff1e2e60d30194c37acb5b38333b 100644 (file)
 #
 #  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
 
index b61ab1edb50dcfef6768dfd7c1ce39862148c9ee..4d2124c3b5e6c447350e40ab03009f05eb1c67e4 100644 (file)
@@ -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
 
index ef1ddeefa0bbde4d5fa68ade116b30b5a069d7f9..2e40cce29165d7d2ec8ecae854f90e22ce96a902 100644 (file)
@@ -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()