From 8f27741af02e5f1125f56475f0bb80e2fe709bf9 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Thu, 11 Feb 2021 06:51:54 +0100 Subject: [PATCH] Minor documentation improvements --- doc/en/genindex.rst | 5 +++++ doc/en/index.rst | 4 +--- doc/en/snippets/AlgorithmParameters.rst | 6 +++--- doc/en/snippets/Background.rst | 4 ++-- doc/en/snippets/BackgroundError.rst | 8 ++++---- doc/en/snippets/CheckingPoint.rst | 10 +++++----- doc/en/snippets/ControlInput.rst | 2 +- doc/en/snippets/Debug.rst | 4 ++-- doc/en/snippets/ExecuteInContainer.rst | 4 ++-- doc/en/snippets/InputVariables.rst | 2 +- doc/en/snippets/OutputVariables.rst | 2 +- doc/en/snippets/SetDebug.rst | 4 ++-- doc/en/snippets/StudyName.rst | 4 ++-- doc/en/snippets/StudyRepertory.rst | 6 +++--- doc/en/snippets/UserDataInit.rst | 2 +- doc/en/snippets/UserPostAnalysis.rst | 2 +- doc/fr/genindex.rst | 5 +++++ doc/fr/index.rst | 4 +--- doc/fr/snippets/AlgorithmParameters.rst | 4 ++-- doc/fr/snippets/ControlInput.rst | 9 ++++----- doc/fr/snippets/Debug.rst | 6 +++--- doc/fr/snippets/ExecuteInContainer.rst | 2 +- doc/fr/snippets/InputVariables.rst | 2 +- doc/fr/snippets/OutputVariables.rst | 2 +- doc/fr/snippets/SetDebug.rst | 2 +- doc/fr/snippets/StudyName.rst | 4 ++-- doc/fr/snippets/StudyRepertory.rst | 8 ++++---- doc/fr/snippets/UserDataInit.rst | 2 +- doc/fr/snippets/UserPostAnalysis.rst | 13 +++++++------ src/daComposant/daCore/Aidsm.py | 8 ++++---- 30 files changed, 73 insertions(+), 67 deletions(-) create mode 100644 doc/en/genindex.rst create mode 100644 doc/fr/genindex.rst diff --git a/doc/en/genindex.rst b/doc/en/genindex.rst new file mode 100644 index 0000000..a0d36cd --- /dev/null +++ b/doc/en/genindex.rst @@ -0,0 +1,5 @@ +.. Fichier fantôme remplacé à la compilation par le véritable index + +=========================================================================================== +Index +=========================================================================================== diff --git a/doc/en/index.rst b/doc/en/index.rst index 4b678d1..5ee146d 100644 --- a/doc/en/index.rst +++ b/doc/en/index.rst @@ -83,10 +83,8 @@ part :ref:`section_license`. reference license glossary + genindex notations bibliography -**Indices and tables** - -* :ref:`genindex` * :ref:`search` diff --git a/doc/en/snippets/AlgorithmParameters.rst b/doc/en/snippets/AlgorithmParameters.rst index 64674f4..ddebd72 100644 --- a/doc/en/snippets/AlgorithmParameters.rst +++ b/doc/en/snippets/AlgorithmParameters.rst @@ -2,10 +2,10 @@ .. index:: single: AlgorithmParameters AlgorithmParameters - *Required command*. This indicates the data assimilation or optimization + *Dictionary*. This variable indicates the data assimilation or optimization algorithm chosen by the keyword "*Algorithm*", and its potential optional - parameters. The algorithm choices are available through the GUI. There - exists for example "3DVAR", "Blue"... Each algorithm is defined, below, by a + parameters. The algorithm choices are available through the GUI. There exists + for example "3DVAR", "Blue"... Each algorithm is defined, below, by a specific subsection. Optionally, the command allows also to add some parameters to control the algorithm. Their values are defined either explicitly or in a "*Dict*" type object. See the diff --git a/doc/en/snippets/Background.rst b/doc/en/snippets/Background.rst index 8f7df4f..e80d35d 100644 --- a/doc/en/snippets/Background.rst +++ b/doc/en/snippets/Background.rst @@ -1,7 +1,7 @@ .. index:: single: Background Background - *Required command*. The variable indicates the background or initial vector - used, previously noted as :math:`\mathbf{x}^b`. Its value is defined as a + *Vector*. The variable indicates the background or initial vector used, + previously noted as :math:`\mathbf{x}^b`. Its value is defined as a "*Vector*" or "*VectorSerie*" type object. Its availability in output is conditioned by the boolean "*Stored*" associated with input. diff --git a/doc/en/snippets/BackgroundError.rst b/doc/en/snippets/BackgroundError.rst index b086de1..a694d64 100644 --- a/doc/en/snippets/BackgroundError.rst +++ b/doc/en/snippets/BackgroundError.rst @@ -1,9 +1,9 @@ .. index:: single: BackgroundError BackgroundError - *Required command*. This indicates the background error covariance matrix, - previously noted as :math:`\mathbf{B}`. Its value is defined as a "*Matrix*" - type object, a "*ScalarSparseMatrix*" type object, or a - "*DiagonalSparseMatrix*" type object, as described in detail in the section + *Matrix*. This indicates the background error covariance matrix, previously + noted as :math:`\mathbf{B}`. Its value is defined as a "*Matrix*" type + object, a "*ScalarSparseMatrix*" type object, or a "*DiagonalSparseMatrix*" + type object, as described in detail in the section :ref:`section_ref_covariance_requirements`. Its availability in output is conditioned by the boolean "*Stored*" associated with input. diff --git a/doc/en/snippets/CheckingPoint.rst b/doc/en/snippets/CheckingPoint.rst index 178e86e..4a1bf12 100644 --- a/doc/en/snippets/CheckingPoint.rst +++ b/doc/en/snippets/CheckingPoint.rst @@ -1,8 +1,8 @@ .. index:: single: CheckingPoint CheckingPoint - *Required command*. The variable indicates the vector used as the state - around which to perform the required check, noted :math:`\mathbf{x}` and - similar to the background :math:`\mathbf{x}^b`. It is defined as a "*Vector*" - or "*VectorSerie*" type object. Its availability in output is conditioned by - the boolean "*Stored*" associated with input. + *Vector*. The variable indicates the vector used as the state around which to + perform the required check, noted :math:`\mathbf{x}` and similar to the + background :math:`\mathbf{x}^b`. It is defined as a "*Vector*" or + "*VectorSerie*" type object. Its availability in output is conditioned by the + boolean "*Stored*" associated with input. diff --git a/doc/en/snippets/ControlInput.rst b/doc/en/snippets/ControlInput.rst index 0408009..2f4c2db 100644 --- a/doc/en/snippets/ControlInput.rst +++ b/doc/en/snippets/ControlInput.rst @@ -1,7 +1,7 @@ .. index:: single: ControlInput ControlInput - *Optional command*. This indicates the control vector used to force the + *Vector*. This variable indicates the control vector used to force the evolution model at each step, usually noted as :math:`\mathbf{U}`. Its value is defined as a "*Vector*" or "*VectorSerie*" type object. When there is no control, it has to be a void string ''. diff --git a/doc/en/snippets/Debug.rst b/doc/en/snippets/Debug.rst index 126edb1..c6f323c 100644 --- a/doc/en/snippets/Debug.rst +++ b/doc/en/snippets/Debug.rst @@ -1,6 +1,6 @@ .. index:: single: Debug Debug - *Optional command*. This define the level of trace and intermediary debug - information. The choices are limited between 0 (for False) and 1 (for + *Boolean value*. This variable define the level of trace and intermediary + debug information. The choices are limited between 0 (for False) and 1 (for True). diff --git a/doc/en/snippets/ExecuteInContainer.rst b/doc/en/snippets/ExecuteInContainer.rst index 06a2f67..5c35cf0 100644 --- a/doc/en/snippets/ExecuteInContainer.rst +++ b/doc/en/snippets/ExecuteInContainer.rst @@ -1,8 +1,8 @@ .. index:: single: ExecuteInContainer ExecuteInContainer - *Optional command*. This variable allows to choose the execution mode in YACS - in a specific container. In its absence or if its value is "No", no separate + *String*. This variable allows to choose the execution mode in YACS in a + specific container. In its absence or if its value is "No", no separate container is used for execution and it runs in the main YACS process. If its value is "Mono", a specific YACS container is created and it is used to host the execution of all nodes in the same process. If its value is "Multi", a diff --git a/doc/en/snippets/InputVariables.rst b/doc/en/snippets/InputVariables.rst index 5b93ac7..f36ae93 100644 --- a/doc/en/snippets/InputVariables.rst +++ b/doc/en/snippets/InputVariables.rst @@ -1,6 +1,6 @@ .. index:: single: InputVariables InputVariables - *Optional command*. This command allows to indicates the name and size of + *Optional command*. This variable allows to indicates the name and size of physical variables that are bundled together in the state vector. This information is dedicated to data processed inside an algorithm. diff --git a/doc/en/snippets/OutputVariables.rst b/doc/en/snippets/OutputVariables.rst index d303cc6..3d7b424 100644 --- a/doc/en/snippets/OutputVariables.rst +++ b/doc/en/snippets/OutputVariables.rst @@ -1,6 +1,6 @@ .. index:: single: OutputVariables OutputVariables - *Optional command*. This command allows to indicates the name and size of + *Optional command*. This variable allows to indicates the name and size of physical variables that are bundled together in the output observation vector. This information is dedicated to data processed inside an algorithm. diff --git a/doc/en/snippets/SetDebug.rst b/doc/en/snippets/SetDebug.rst index 8360b9a..c314997 100644 --- a/doc/en/snippets/SetDebug.rst +++ b/doc/en/snippets/SetDebug.rst @@ -1,8 +1,8 @@ .. index:: single: SetDebug SetDebug - *Boolean value*. This key requires the activation, or not, of the debug mode - during the function or operator evaluation. The default is "False", the + *Boolean value*. This variable leads to the activation, or not, of the debug + mode during the function or operator evaluation. The default is "False", the choices are "True" or "False". Example: diff --git a/doc/en/snippets/StudyName.rst b/doc/en/snippets/StudyName.rst index 9790252..8842d84 100644 --- a/doc/en/snippets/StudyName.rst +++ b/doc/en/snippets/StudyName.rst @@ -1,5 +1,5 @@ .. index:: single: StudyName StudyName - *Required command*. This is an open string to describe the ADAO study by a - name or a sentence. + *String*. This variable is an open string to identify or describe the ADAO + study by a name or a sentence. diff --git a/doc/en/snippets/StudyRepertory.rst b/doc/en/snippets/StudyRepertory.rst index f18433c..4622fa8 100644 --- a/doc/en/snippets/StudyRepertory.rst +++ b/doc/en/snippets/StudyRepertory.rst @@ -1,6 +1,6 @@ .. index:: single: StudyRepertory StudyRepertory - *Optional command*. If available, this directory is used as base name for - calculation, and used to find all the script files, given by name without - path, that can be used to define some other commands by scripts. + *String*. If available, the directory specified by this string is used as + base name for calculation, and also used to find all the script files given + by name without path, that can define some other commands by scripts. diff --git a/doc/en/snippets/UserDataInit.rst b/doc/en/snippets/UserDataInit.rst index e37e23d..2d917dc 100644 --- a/doc/en/snippets/UserDataInit.rst +++ b/doc/en/snippets/UserDataInit.rst @@ -1,7 +1,7 @@ .. index:: single: UserDataInit UserDataInit - *Optional command*. This commands allows to initialize some parameters or + *Script name*. This variable allows to initialize some parameters or data automatically before algorithm input processing. It indicates a script file name to be executed before entering in initialization phase of chosen variables. diff --git a/doc/en/snippets/UserPostAnalysis.rst b/doc/en/snippets/UserPostAnalysis.rst index 9ffcfb9..498267b 100644 --- a/doc/en/snippets/UserPostAnalysis.rst +++ b/doc/en/snippets/UserPostAnalysis.rst @@ -2,7 +2,7 @@ .. index:: single: UserPostAnalysis Template UserPostAnalysis - *Optional command*. This commands allows to process some parameters or data + *Multiline string*. This variable allows to process some parameters or data automatically after data assimilation or optimization algorithm processing. Its value is defined as a script file or a string, allowing to put post-processing code directly inside the ADAO case. Common templates are diff --git a/doc/fr/genindex.rst b/doc/fr/genindex.rst new file mode 100644 index 0000000..a0d36cd --- /dev/null +++ b/doc/fr/genindex.rst @@ -0,0 +1,5 @@ +.. Fichier fantôme remplacé à la compilation par le véritable index + +=========================================================================================== +Index +=========================================================================================== diff --git a/doc/fr/index.rst b/doc/fr/index.rst index b6ed5b2..dcf362d 100644 --- a/doc/fr/index.rst +++ b/doc/fr/index.rst @@ -87,10 +87,8 @@ pas de lire la partie :ref:`section_license`. reference license glossary + genindex notations bibliography -**Index et tables** - -* :ref:`genindex` * :ref:`search` diff --git a/doc/fr/snippets/AlgorithmParameters.rst b/doc/fr/snippets/AlgorithmParameters.rst index 1239884..6053104 100644 --- a/doc/fr/snippets/AlgorithmParameters.rst +++ b/doc/fr/snippets/AlgorithmParameters.rst @@ -2,8 +2,8 @@ .. index:: single: AlgorithmParameters AlgorithmParameters - *Commande obligatoire*. Elle définit l'algorithme d'assimilation de données - ou d'optimisation choisi par le mot-clé "*Algorithm*", et ses éventuels + *Dictionnaire*. La variable définit l'algorithme d'assimilation de données ou + d'optimisation choisi par le mot-clé "*Algorithm*", et ses éventuels paramètres optionnels. Les choix d'algorithmes sont disponibles à travers l'interface graphique. Il existe par exemple le "3DVAR", le "Blue"... Chaque algorithme est défini, plus loin, par une sous-section spécifique. De manière diff --git a/doc/fr/snippets/ControlInput.rst b/doc/fr/snippets/ControlInput.rst index bfa7a3a..cfb518a 100644 --- a/doc/fr/snippets/ControlInput.rst +++ b/doc/fr/snippets/ControlInput.rst @@ -1,8 +1,7 @@ .. index:: single: ControlInput ControlInput - *Commande optionnelle*. Elle indique le vecteur de contrôle utilisé pour - forcer le modèle d'évolution à chaque pas, usuellement noté - :math:`\mathbf{U}`. Sa valeur est définie comme un objet de type "*Vector*" - ou "*VectorSerie*". Lorsqu'il n'y a pas de contrôle, sa valeur doit être une - chaîne vide ''. + *Vecteur*. La variable indique le vecteur de contrôle utilisé pour forcer le + modèle d'évolution à chaque pas, usuellement noté :math:`\mathbf{U}`. Sa + valeur est définie comme un objet de type "*Vector*" ou "*VectorSerie*". + Lorsqu'il n'y a pas de contrôle, sa valeur doit être une chaîne vide ''. diff --git a/doc/fr/snippets/Debug.rst b/doc/fr/snippets/Debug.rst index f0bafe4..9f5a558 100644 --- a/doc/fr/snippets/Debug.rst +++ b/doc/fr/snippets/Debug.rst @@ -1,6 +1,6 @@ .. index:: single: Debug Debug - *Commande optionnelle*. Elle définit le niveau de sorties et d'informations - intermédiaires de débogage. Les choix sont limités entre 0 (pour False) et 1 - (pour True). + *Valeur booléenne*. La variable définit le niveau de sorties et + d'informations intermédiaires de débogage. Les choix sont limités entre 0 + (pour False) et 1 (pour True). diff --git a/doc/fr/snippets/ExecuteInContainer.rst b/doc/fr/snippets/ExecuteInContainer.rst index 89f9f21..8f3e55c 100644 --- a/doc/fr/snippets/ExecuteInContainer.rst +++ b/doc/fr/snippets/ExecuteInContainer.rst @@ -1,7 +1,7 @@ .. index:: single: ExecuteInContainer ExecuteInContainer - *Commande optionnelle*. Cette variable permet de choisir le mode d'exécution + *Chaîne de caractères*. Cette variable permet de choisir le mode d'exécution dans YACS en container spécifique. En son absence ou si sa valeur est "No", il n'est pas utilisé de container séparé pour l'exécution et elle se déroule dans le processus principal de YACS. Si sa valeur est "Mono", un container diff --git a/doc/fr/snippets/InputVariables.rst b/doc/fr/snippets/InputVariables.rst index 242e10a..92d4abc 100644 --- a/doc/fr/snippets/InputVariables.rst +++ b/doc/fr/snippets/InputVariables.rst @@ -1,7 +1,7 @@ .. index:: single: InputVariables InputVariables - *Commande optionnelle*. Elle permet d'indiquer le nom et la taille des + *Commande optionnelle*. La variable permet d'indiquer le nom et la taille des variables physiques qui sont rassemblées dans le vecteur d'état. Cette information est destinée à être utilisée dans le traitement algorithmique interne des données. diff --git a/doc/fr/snippets/OutputVariables.rst b/doc/fr/snippets/OutputVariables.rst index 9ccae77..02c9e95 100644 --- a/doc/fr/snippets/OutputVariables.rst +++ b/doc/fr/snippets/OutputVariables.rst @@ -1,7 +1,7 @@ .. index:: single: OutputVariables OutputVariables - *Commande optionnelle*. Elle permet d'indiquer le nom et la taille des + *Commande optionnelle*. La variable permet d'indiquer le nom et la taille des variables physiques qui sont rassemblées dans le vecteur d'observation. Cette information est destinée à être utilisée dans le traitement algorithmique interne des données. diff --git a/doc/fr/snippets/SetDebug.rst b/doc/fr/snippets/SetDebug.rst index 0717636..0928a9d 100644 --- a/doc/fr/snippets/SetDebug.rst +++ b/doc/fr/snippets/SetDebug.rst @@ -1,7 +1,7 @@ .. index:: single: SetDebug SetDebug - *Valeur booléenne*. Cette clé requiert l'activation, ou pas, du mode de + *Valeur booléenne*. La variable conduit à l'activation, ou pas, du mode de débogage durant l'évaluation de la fonction ou de l'opérateur. La valeur par défaut est "True", les choix sont "True" ou "False". diff --git a/doc/fr/snippets/StudyName.rst b/doc/fr/snippets/StudyName.rst index 1a6bf43..3f5cccd 100644 --- a/doc/fr/snippets/StudyName.rst +++ b/doc/fr/snippets/StudyName.rst @@ -1,5 +1,5 @@ .. index:: single: StudyName StudyName - *Commande obligatoire*. C'est une chaîne de caractères quelconque pour - décrire l'étude ADAO par un nom ou une déclaration. + *Chaîne de caractères*. La variable est une chaîne de caractères quelconque + pour identifier ou décrire l'étude ADAO par un nom ou une déclaration. diff --git a/doc/fr/snippets/StudyRepertory.rst b/doc/fr/snippets/StudyRepertory.rst index af99bf5..4a0b91b 100644 --- a/doc/fr/snippets/StudyRepertory.rst +++ b/doc/fr/snippets/StudyRepertory.rst @@ -1,7 +1,7 @@ .. index:: single: StudyRepertory StudyRepertory - *Commande optionnelle*. S'il existe, ce répertoire est utilisé comme base - pour les calculs, et il est utilisé pour trouver les fichiers de script, - donnés par nom sans répertoire, qui peuvent être utilisés pour définir - certaines variables. + *Chaîne de caractères*. Si il existe, le répertoire désigné par cette chaîne + de caractères est utilisé comme base pour les calculs, et il est aussi + utilisé pour trouver les fichiers de script qui sont définis par nom sans + répertoire, qui peuvent définir certaines variables. diff --git a/doc/fr/snippets/UserDataInit.rst b/doc/fr/snippets/UserDataInit.rst index f5d3922..f554e6c 100644 --- a/doc/fr/snippets/UserDataInit.rst +++ b/doc/fr/snippets/UserDataInit.rst @@ -1,7 +1,7 @@ .. index:: single: UserDataInit UserDataInit - *Commande optionnelle*. Elle permet d'initialiser certains paramètres ou + *Nom de script*. La variable permet d'initialiser certains paramètres ou certaines données automatiquement avant le traitement de données d'entrée pour l'assimilation de données ou l'optimisation. Pour cela, elle indique un nom de fichier de script à exécuter avant d'entrer dans l'initialisation des diff --git a/doc/fr/snippets/UserPostAnalysis.rst b/doc/fr/snippets/UserPostAnalysis.rst index a11cb3a..f7c6eb2 100644 --- a/doc/fr/snippets/UserPostAnalysis.rst +++ b/doc/fr/snippets/UserPostAnalysis.rst @@ -2,9 +2,10 @@ .. index:: single: UserPostAnalysis Template UserPostAnalysis - *Commande optionnelle*. Elle permet de traiter des paramètres ou des - résultats après le déroulement de l'algorithme d'assimilation de données ou - d'optimisation. Sa valeur est définie comme un fichier script ou une chaîne - de caractères, permettant de produire directement du code de post-processing - dans un cas ADAO. Des exemples courants (squelettes) sont fournis pour aider - l'utilisateur ou pour faciliter l'élaboration d'un cas. + *Chaîne de caractères multi-lignes*. La variable permet de traiter des + paramètres ou des résultats après le déroulement de l'algorithme + d'assimilation de données ou d'optimisation. Sa valeur est définie comme un + fichier script ou une chaîne de caractères, permettant de produire + directement du code de post-processing dans un cas ADAO. Des exemples + courants (squelettes ou "templates") sont fournis pour aider l'utilisateur ou + pour faciliter l'élaboration d'un cas. diff --git a/src/daComposant/daCore/Aidsm.py b/src/daComposant/daCore/Aidsm.py index cd75513..6281c84 100644 --- a/src/daComposant/daCore/Aidsm.py +++ b/src/daComposant/daCore/Aidsm.py @@ -704,10 +704,10 @@ class Aidsm(object): if os.path.isfile(os.path.join(trypath,fname)): root, ext = os.path.splitext(fname) if ext != ".py": continue - fc = open(os.path.join(trypath,fname)).read() - iselal = bool("class ElementaryAlgorithm" in fc) - if iselal and ext == '.py' and root != '__init__': - files.append(root) + with open(os.path.join(trypath,fname)) as fc: + iselal = bool("class ElementaryAlgorithm" in fc.read()) + if iselal and ext == '.py' and root != '__init__': + files.append(root) files.sort() return files -- 2.39.2