From bceaecf892b9bf3664b5c3b4155aa98c7c8ebfe1 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Tue, 14 Apr 2015 09:05:49 +0200 Subject: [PATCH] Documentation and source minor corrections and improvements --- doc/en/advanced.rst | 19 +++++++++------- doc/fr/advanced.rst | 22 +++++++++++-------- doc/fr/tui.rst | 20 ++++++++--------- .../daAlgorithms/ParticleSwarmOptimization.py | 4 ++-- src/daSalome/adaoBuilder.py | 6 ++--- 5 files changed, 39 insertions(+), 32 deletions(-) diff --git a/doc/en/advanced.rst b/doc/en/advanced.rst index f936836..84a5fc5 100644 --- a/doc/en/advanced.rst +++ b/doc/en/advanced.rst @@ -131,14 +131,14 @@ In all cases, the standard output and errors come in the launching terminal. Running an ADAO calculation scheme in YACS using a TUI user mode ---------------------------------------------------------------- -This section describes how to execute in TUI (Text User Interface) mode a YACS -calculation scheme, obtained using the ADAO "Export to YACS" function. It uses -the standard YACS TUI mode, which is briefly recalled here (see YACS -documentation for more information) through a simple example. As described in -documentation, a XML scheme can be loaded in a Python. We give here a whole -sequence of command lines to test the validity of the scheme before executing -it, adding some initial supplementary ones to explicitly load the types catalog -to avoid weird difficulties:: +This section describes how to execute in TUI (Text User Interface) YACS mode a +YACS calculation scheme, obtained in the graphical interface by using the ADAO +"Export to YACS" function. It uses the standard YACS TUI mode, which is briefly +recalled here (see YACS documentation for more information) through a simple +example. As described in documentation, a XML scheme can be loaded in a Python. +We give here a whole sequence of command lines to test the validity of the +scheme before executing it, adding some initial supplementary ones to explicitly +load the types catalog to avoid weird difficulties:: import pilot import SALOMERuntime @@ -304,6 +304,9 @@ operator function before and during enabling parallelism... in case of doubt, it is recommended NOT TO ACTIVATE this parallelism. +It is also recalled that one have to choose the type "*multi*" for the default +container in order to launch the scheme, to allow a really parallel execution. + Switching from a version of ADAO to a newer one ----------------------------------------------- diff --git a/doc/fr/advanced.rst b/doc/fr/advanced.rst index 28ff5ff..d798074 100644 --- a/doc/fr/advanced.rst +++ b/doc/fr/advanced.rst @@ -138,15 +138,15 @@ lancement. Exécuter un schéma de calcul ADAO dans YACS en utilisant le mode "texte" (TUI) ------------------------------------------------------------------------------ -Cette section décrit comment exécuter en mode TUI (Text User Interface) un -schéma de calcul YACS, obtenu par la fonction "*Exporter vers YACS*" d'ADAO. -Cela utilise le mode texte standard de YACS, qui est rapidement rappelé ici -(voir la documentation YACS pour de plus amples informations) à travers un -exemple simple. Comme décrit dans la documentation, un schéma XML peut être -chargé en python. On donne ici une séquence complète de commandes pour tester la -validité du schéma avant de l'exécuter, ajoutant des lignes supplémentaires -initiales pour charger de manière explicite le catalogue de types pour éviter -d'obscures difficultés:: +Cette section décrit comment exécuter en mode TUI (Text User Interface) YACS un +schéma de calcul YACS, obtenu dans l'interface graphique par la fonction +"*Exporter vers YACS*" d'ADAO. Cela utilise le mode texte standard de YACS, qui +est rapidement rappelé ici (voir la documentation YACS pour de plus amples +informations) à travers un exemple simple. Comme décrit dans la documentation, +un schéma XML peut être chargé en python. On donne ici une séquence complète de +commandes pour tester la validité du schéma avant de l'exécuter, ajoutant des +lignes supplémentaires initiales pour charger de manière explicite le catalogue +de types pour éviter d'obscures difficultés:: #-*-coding:iso-8859-1-*- import pilot @@ -322,6 +322,10 @@ parall en cas de doute, il est recommandé de NE PAS ACTIVER ce parallélisme. +On rappelle aussi qu'il faut choisir dans YACS un container par défaut de type +"*multi*" pour le lancement du schéma, pour permettre une exécution +véritablement parallèle. + Passer d'une version d'ADAO à une nouvelle ------------------------------------------ diff --git a/doc/fr/tui.rst b/doc/fr/tui.rst index 41b3a93..746dbf6 100644 --- a/doc/fr/tui.rst +++ b/doc/fr/tui.rst @@ -498,16 +498,16 @@ Effectuer le calcul nécessaire du parallélisme interne des algorithmes dans ADAO et du parallélisme interne du ou des codes de simulation utilisé. -.. index:: single: generateYACSscheme - -**executeYACSScheme** (*File*) - Cete commande génère le schéma YACS [YACS]_ du cas de calcul dans le fichier - requis "*File*", et en lance l'exécution dans l'interpréteur YACS, comme on - peut le réaliser en utilisant l'éditeur standard de cas ADAO. Les sorties - standard et d'erreur sont celles de l'interpréteur YACS. On dispose si - nécessaire du parallélisme de noeuds et blocs dans YACS, du parallélisme - interne des algorithmes dans ADAO et du parallélisme interne du ou des codes - de simulation utilisé. +.. .. index:: single: generateYACSscheme +.. +.. **executeYACSScheme** (*File*) +.. Cete commande génère le schéma YACS [YACS]_ du cas de calcul dans le fichier +.. requis "*File*", et en lance l'exécution dans l'interpréteur YACS, comme on +.. peut le réaliser en utilisant l'éditeur standard de cas ADAO. Les sorties +.. standard et d'erreur sont celles de l'interpréteur YACS. On dispose si +.. nécessaire du parallélisme de noeuds et blocs dans YACS, du parallélisme +.. interne des algorithmes dans ADAO et du parallélisme interne du ou des codes +.. de simulation utilisé. .. index:: single: execute diff --git a/src/daComposant/daAlgorithms/ParticleSwarmOptimization.py b/src/daComposant/daAlgorithms/ParticleSwarmOptimization.py index c9ab24f..affef66 100644 --- a/src/daComposant/daAlgorithms/ParticleSwarmOptimization.py +++ b/src/daComposant/daAlgorithms/ParticleSwarmOptimization.py @@ -87,8 +87,8 @@ class ElementaryAlgorithm(BasicObjects.Algorithm): listval = ["BMA", "OMA", "OMB", "CurrentState", "CostFunctionJ", "Innovation", "SimulatedObservationAtBackground", "SimulatedObservationAtCurrentState", "SimulatedObservationAtOptimum"] ) self.defineRequiredParameter( # Pas de type - name = "Bounds", - message = "Liste des valeurs de bornes", + name = "BoxBounds", + message = "Liste des valeurs de bornes d'incréments de paramètres", ) def run(self, Xb=None, Y=None, U=None, HO=None, EM=None, CM=None, R=None, B=None, Q=None, Parameters=None): diff --git a/src/daSalome/adaoBuilder.py b/src/daSalome/adaoBuilder.py index c96bb86..fa88b28 100644 --- a/src/daSalome/adaoBuilder.py +++ b/src/daSalome/adaoBuilder.py @@ -56,8 +56,7 @@ class New(object): ThreeFunctions = None, Variable = None, Vector = None, - VectorSerie = None - ): + VectorSerie = None): "Interface unique de définition de variables d'entrées par argument" self.__dumper.register("set",dir(),locals(),None,True) try: @@ -435,7 +434,7 @@ class New(object): not ThreeFunctions.has_key("Direct") or \ not ThreeFunctions.has_key("Tangent") or \ not ThreeFunctions.has_key("Adjoint"): - raise ValueError("ThreeFunctions has to be a dictionnary and to have the 3 keys Direct, Tangent, Adjoint") + raise ValueError("ThreeFunctions has to be a dictionnary and to have the 3 keys Direct, Tangent, Adjoint") __Function = ThreeFunctions __Function.update(__Parameters) else: @@ -637,6 +636,7 @@ class _ImportFromScript(object): else: return getattr(self.__scriptfile, __varname) def getstring(self): + "Renvoie le script complet" return self.__scriptstring # ============================================================================== -- 2.39.2