From: Jean-Philippe ARGAUD Date: Tue, 19 Mar 2019 22:14:30 +0000 (+0100) Subject: Updating documentation by review and snippets (11) X-Git-Tag: V9_3_0rc2~19 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=e3ac534acf039e80fa6f4d7037ab902e0e414e1d;p=modules%2Fadao.git Updating documentation by review and snippets (11) --- diff --git a/doc/en/ref_entry_types.rst b/doc/en/ref_entry_types.rst index 1fe0193..2784ccc 100644 --- a/doc/en/ref_entry_types.rst +++ b/doc/en/ref_entry_types.rst @@ -90,12 +90,23 @@ themselves may be either a data string (a "*String*"), or a script file (a **VectorSerie** This indicates a variable that has to be filled by a list of vectors. +.. index:: single: DataFile +.. index:: single: ColNames +.. index:: single: ColMajor + +**DataFile**, **ColNames**, **ColMajor** + This indicates the file name for data of text type (TXT, CSV, TSV...) or + binary type (NPY, NPZ, SDF...), ordered in rows (``ColMajor=False``) or in + lines (``ColMajor=True``),of which is selected all the variables or only + those of ``ColNames`` list. + When a command or keyword can be filled by a script file name, specified by the pseudo-type "*Script*", the script has to contain a variable or a method that has the same name as the one to be filled. In other words, when importing the -script in a YACS Python node, it must create a variable of the good name in the -current name space of the node. For example, a Python script making available -the background variable, named "*Background*", must have the following form:: +script in a Python command or a YACS Python node, it must create a variable of +the good name in the current name space of the node. For example, a Python +script making available the background variable, named "*Background*", must +have the following form:: ... Background =... diff --git a/doc/en/snippets/Background.rst b/doc/en/snippets/Background.rst index 41fdb54..c83f265 100644 --- a/doc/en/snippets/Background.rst +++ b/doc/en/snippets/Background.rst @@ -3,5 +3,5 @@ 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*" or a *VectorSerie*" type object. Its availability in output is - conditioned by the boolean "*Stored*" associated with input. + "*Vector*", "*VectorSerie*" or "*DataFile*" type object. 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 4a5895d..8a6708f 100644 --- a/doc/en/snippets/CheckingPoint.rst +++ b/doc/en/snippets/CheckingPoint.rst @@ -3,6 +3,6 @@ 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*" - type object. Its availability in output is conditioned by the boolean - "*Stored*" associated with input. + similar to the background :math:`\mathbf{x}^b`. It is defined as a + "*Vector*", "*VectorSerie*" or "*DataFile* 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 2d91ce3..b341947 100644 --- a/doc/en/snippets/ControlInput.rst +++ b/doc/en/snippets/ControlInput.rst @@ -3,5 +3,5 @@ ControlInput *Optional command*. This 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 a *VectorSerie* type object. When there is no - control, it has to be a void string ''. + is defined as a "*Vector*", "*VectorSerie*" or "*DataFile* type object. When + there is no control, it has to be a void string ''. diff --git a/doc/en/snippets/Observation.rst b/doc/en/snippets/Observation.rst index dffb564..1608124 100644 --- a/doc/en/snippets/Observation.rst +++ b/doc/en/snippets/Observation.rst @@ -3,6 +3,6 @@ Observation *Vector*. The variable indicates the observation vector used for data assimilation or optimization, usually noted as :math:`\mathbf{y}^o`. Its - value is defined as a "*Vector*" or a *VectorSerie* type object. Its - availability in output is conditioned by the boolean "*Stored*" associated - with input. + value is defined as a "*Vector*", "*VectorSerie*" or "*DataFile* type object. + Its availability in output is conditioned by the boolean "*Stored*" + associated with input. diff --git a/doc/en/tui.rst b/doc/en/tui.rst index 0911b9f..707ebff 100644 --- a/doc/en/tui.rst +++ b/doc/en/tui.rst @@ -300,13 +300,16 @@ The available commands are: .. index:: single: setBackground -**setBackground** (*Vector, VectorSerie, Script, Stored*) - This command allows to set the background :math:`\mathbf{x}^b`. Depending on - the algorithm, it can be defined as a simple vector by "*Vector*", or as a - vector list by "*VectorSerie*". If it is defined by a script in the +**setBackground** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*) + This command allows to set the background :math:`\mathbf{x}^b`. Depending + on the algorithm, it can be defined as a simple vector by "*Vector*", or as + a vector list by "*VectorSerie*". If it is defined by a script in the "*Script*" keyword, the vector is of type "*Vector*" (by default) or - "*VectorSerie*" according to whether one of these variables is positioned to - "*True*". + "*VectorSerie*" according to whether one of these variables is positioned + to "*True*". If there is a data file given by "*DataFile*" (selecting, in + rows by default or in lines as chosen by "*ColMajor*", all the variables by + default or those from the list "*ColNames*"), the vector is of type + "*Vector*". .. index:: single: setBackgroundError @@ -323,13 +326,16 @@ The available commands are: .. index:: single: setCheckingPoint -**setCheckingPoint** (*Vector, VectorSerie, Script, Stored*) +**setCheckingPoint** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*) This command allows to set a current point :math:`\mathbf{x}` used in a checking algorithm. Depending on the algorithm, it can be defined as a simple vector by "*Vector*", or as a vector list by "*VectorSerie*". If it is defined by a script in the "*Script*" keyword, the vector is of type - "*Vector*" (by default) or "*VectorSerie*" according to whether one of these - variables is positioned to "*True*". + "*Vector*" (by default) or "*VectorSerie*" according to whether one of + these variables is positioned to "*True*". If there is a data file given by + "*DataFile*" (selecting, in rows by default or in lines as chosen by + "*ColMajor*", all the variables by default or those from the list + "*ColNames*"), the vector is of type "*Vector*". .. index:: single: setControlModel @@ -351,13 +357,16 @@ The available commands are: .. index:: single: setControlInput -**setControlInput** (*Vector, VectorSerie, Script, Stored*) +**setControlInput** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*) This command allows to set the control vector :math:`\mathbf{u}`. Depending on the algorithm, it can be defined as a simple vector by "*Vector*", or as a vector list by "*VectorSerie*". If it is defined by a script in the "*Script*" keyword, the vector is of type "*Vector*" (by default) or - "*VectorSerie*" according to whether one of these variables is positioned to - "*True*". + "*VectorSerie*" according to whether one of these variables is positioned + to "*True*". If there is a data file given by "*DataFile*" (selecting, in + rows by default or in lines as chosen by "*ColMajor*", all the variables by + default or those from the list "*ColNames*"), the vector is of type + "*Vector*". .. index:: single: setEvolutionError @@ -391,13 +400,16 @@ The available commands are: .. index:: single: setObservation -**setObservation** (*Vector, VectorSerie, Script, Stored*) +**setObservation** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*) This command allows to set the observation vector :math:`\mathbf{y}^o`. Depending on the algorithm, it can be defined as a simple vector by "*Vector*", or as a vector list by "*VectorSerie*". If it is defined by a script in the "*Script*" keyword, the vector is of type "*Vector*" (by default) or "*VectorSerie*" according to whether one of these variables is - positioned to "*True*". + positioned to "*True*". If there is a data file given by "*DataFile*" + (selecting, in rows by default or in lines as chosen by "*ColMajor*", all + the variables by default or those from the list "*ColNames*"), the vector + is of type "*Vector*". .. index:: single: setObservationError @@ -543,16 +555,16 @@ with these Python external case operations. This command allows to read or load a calculation case, from a file named "*FileName*" or a content in memory by "*Content*" or "*Object*". The "*Formater*" keyword can indicate "*TUI*" for commands of textual - application programming interface, and "*COM*" for commands of COMM type - coming from EFICAS interface for ADAO. + application programming interface (default), and "*COM*" for commands of + COMM type coming from EFICAS interface for ADAO. .. index:: single: dump **dump** (*FileName, Formater*) This command allows to save, in a file named "*FileName*", the commands of the current calculation case. The "*Formater*" keyword can indicate "*TUI*" - for commands of textual application programming interface, and "*YACS*" for - commands of type YACS. + for commands of textual application programming interface (default), and + "*YACS*" for commands of type YACS. .. index:: single: convert .. index:: single: FileNameFrom diff --git a/doc/fr/ref_entry_types.rst b/doc/fr/ref_entry_types.rst index d4f8ab8..b4f2f6c 100644 --- a/doc/fr/ref_entry_types.rst +++ b/doc/fr/ref_entry_types.rst @@ -92,13 +92,24 @@ caractères (un "*String*"), soit par un fichier script (un "*Script*"): **VectorSerie** Cela indique une variable qui doit être remplie comme une liste de vecteurs. +.. index:: single: DataFile +.. index:: single: ColNames +.. index:: single: ColMajor + +**DataFile**, **ColNames**, **ColMajor** + Cela indique le nom d'un fichier de données de type texte (TXT, CSV, + TSV...) ou de type binaire (NPY, NPZ, SDF...), rangées en colonnes + (``ColMajor=False``) ou rangées en lignes (``ColMajor=True``), dont on + sélectionne toutes les variables ou uniquement celles de la liste + ``ColNames``. + Lorsqu'une commande ou un mot-clé peut être rempli par un nom de fichier script désigné par le pseudo-type "*Script*", ce script doit présenter une variable ou -une méthode que porte le même nom que la variable à remplir. En d'autres termes, -lorsque l'on importe le script dans un noeud Python de YACS, il doit créer une -variable du bon nom dans l'espace de nommage courant du noeud. Par exemple, un -script Python rendant disponible la variable d'ébauche, nommée "*Background*", -doit présenter la forme suivante:: +une méthode que porte le même nom que la variable à remplir. En d'autres +termes, lorsque l'on importe le script dans une commande Python ou un noeud +Python de YACS, il doit créer une variable du bon nom dans l'espace de nommage +courant du noeud. Par exemple, un script Python rendant disponible la variable +d'ébauche, nommée "*Background*", doit présenter la forme suivante:: ... Background =... diff --git a/doc/fr/snippets/Background.rst b/doc/fr/snippets/Background.rst index 1f718ed..2359b83 100644 --- a/doc/fr/snippets/Background.rst +++ b/doc/fr/snippets/Background.rst @@ -3,5 +3,5 @@ Background *Vecteur*. La variable désigne le vecteur d'ébauche ou d'initialisation, usuellement noté :math:`\mathbf{x}^b`. Sa valeur est définie comme un objet - de type "*Vector*" ou de type "*VectorSerie*". Sa disponibilité en sortie est - conditionnée par le booléen "*Stored*" associé en entrée. + de type "*Vector*", "*VectorSerie*" ou "*DataFile*". Sa disponibilité en + sortie est conditionnée par le booléen "*Stored*" associé en entrée. diff --git a/doc/fr/snippets/CheckingPoint.rst b/doc/fr/snippets/CheckingPoint.rst index 4de7cdf..fa8992b 100644 --- a/doc/fr/snippets/CheckingPoint.rst +++ b/doc/fr/snippets/CheckingPoint.rst @@ -4,5 +4,5 @@ CheckingPoint *Vecteur*. La variable désigne le vecteur utilisé comme l'état autour duquel réaliser le test requis, noté :math:`\mathbf{x}`, similaire à l'ébauche :math:`\mathbf{x}^b`. Sa valeur est définie comme un objet de type - "*Vector*". Sa disponibilité en sortie est conditionnée par le booléen - "*Stored*" associé en entrée. + "*Vector*", "*VectorSerie*" ou "*DataFile*". Sa disponibilité en sortie est + conditionnée par le booléen "*Stored*" associé en entrée. diff --git a/doc/fr/snippets/ControlInput.rst b/doc/fr/snippets/ControlInput.rst index 9c97e83..af46c88 100644 --- a/doc/fr/snippets/ControlInput.rst +++ b/doc/fr/snippets/ControlInput.rst @@ -3,6 +3,6 @@ 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 de type "*VectorSerie*". Lorsqu'il n'y a pas de contrôle, sa valeur doit - être une chaîne vide ''. + :math:`\mathbf{U}`. Sa valeur est définie comme un objet de type "*Vector*", + "*VectorSerie*" ou "*DataFile*". Lorsqu'il n'y a pas de contrôle, sa valeur + doit être une chaîne vide ''. diff --git a/doc/fr/snippets/Observation.rst b/doc/fr/snippets/Observation.rst index c4f4efd..346723d 100644 --- a/doc/fr/snippets/Observation.rst +++ b/doc/fr/snippets/Observation.rst @@ -3,6 +3,6 @@ Observation *Vecteur*. La variable désigne le vecteur d'observation utilisé en assimilation de données ou en optimisation, et usuellement noté - :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de type "*Vector*" - ou de type "*VectorSerie*". Sa disponibilité en sortie est conditionnée par - le booléen "*Stored*" associé en entrée. + :math:`\mathbf{y}^o`. Sa valeur est définie comme un objet de type + "*Vector*", "*VectorSerie*" ou "*DataFile*". Sa disponibilité en sortie est + conditionnée par le booléen "*Stored*" associé en entrée. diff --git a/doc/fr/tui.rst b/doc/fr/tui.rst index 1d17515..ef576d5 100644 --- a/doc/fr/tui.rst +++ b/doc/fr/tui.rst @@ -312,12 +312,16 @@ Les commandes disponibles sont les suivantes : .. index:: single: setBackground -**setBackground** (*Vector, VectorSerie, Script, Stored*) +**setBackground** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*) Cette commande permet de définir l'ébauche :math:`\mathbf{x}^b`. Selon les algorithmes, on peut la définir comme un vecteur simple par "*Vector*", ou comme une liste de vecteurs par "*VectorSerie*". Si on la définit par un script dans "*Script*", le vecteur est de type "*Vector*" (par défaut) ou - "*VectorSerie*" selon que l'une de ces variables est placée à "*True*". + "*VectorSerie*" selon que l'une de ces variables est placée à "*True*". Si + on utilise un fichier de données par "*DataFile*" (en sélectionnant, en + colonne par défaut ou en ligne selon "*ColMajor*", toutes les variables par + défaut ou celles de la liste "*ColNames*"), le vecteur est de type + "*Vector*". .. index:: single: setBackgroundError @@ -334,13 +338,17 @@ Les commandes disponibles sont les suivantes : .. index:: single: setCheckingPoint -**setCheckingPoint** (*Vector, VectorSerie, Script, Stored*) - Cette commande permet de définir un point courant :math:`\mathbf{x}` utilisé - pour un algorithme de vérification. Selon les algorithmes, on peut le - définir comme un vecteur simple par "*Vector*", ou comme une liste de +**setCheckingPoint** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*) + Cette commande permet de définir un point courant :math:`\mathbf{x}` + utilisé pour un algorithme de vérification. Selon les algorithmes, on peut + le définir comme un vecteur simple par "*Vector*", ou comme une liste de vecteurs par "*VectorSerie*". Si on le définit par un script dans "*Script*", le vecteur est de type "*Vector*" (par défaut) ou - "*VectorSerie*" selon que l'une de ces variables est placée à "*True*". + "*VectorSerie*" selon que l'une de ces variables est placée à "*True*". Si + on utilise un fichier de données par "*DataFile*" (en sélectionnant, en + colonne par défaut ou en ligne selon "*ColMajor*", toutes les variables par + défaut ou celles de la liste "*ColNames*"), le vecteur est de type + "*Vector*". .. index:: single: setControlModel @@ -363,13 +371,16 @@ Les commandes disponibles sont les suivantes : .. index:: single: setControlInput -**setControlInput** (*Vector, VectorSerie, Script, Stored*) +**setControlInput** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*) Cette commande permet de définir le vecteur de contrôle :math:`\mathbf{u}`. Selon les algorithmes, on peut le définir comme un vecteur simple par "*Vector*", ou comme une liste de vecteurs par "*VectorSerie*". Si on le définit par un script dans "*Script*", le vecteur est de type "*Vector*" (par défaut) ou "*VectorSerie*" selon que l'une de ces variables est placée - à "*True*". + à "*True*". Si on utilise un fichier de données par "*DataFile*" (en + sélectionnant, en colonne par défaut ou en ligne selon "*ColMajor*", toutes + les variables par défaut ou celles de la liste "*ColNames*"), le vecteur + est de type "*Vector*". .. index:: single: setEvolutionError @@ -404,13 +415,16 @@ Les commandes disponibles sont les suivantes : .. index:: single: setObservation -**setObservation** (*Vector, VectorSerie, Script, Stored*) +**setObservation** (*Vector, VectorSerie, Script, DataFile, ColNames, ColMajor, Stored*) Cette commande permet de définir le vecteur d'observation :math:`\mathbf{y}^o`. Selon les algorithmes, on peut le définir comme un vecteur simple par "*Vector*", ou comme une liste de vecteurs par "*VectorSerie*". Si on le définit par un script dans "*Script*", le vecteur est de type "*Vector*" (par défaut) ou "*VectorSerie*" selon que l'une de - ces variables est placée à "*True*". + ces variables est placée à "*True*". Si on utilise un fichier de données + par "*DataFile*" (en sélectionnant, en colonne par défaut ou en ligne selon + "*ColMajor*", toutes les variables par défaut ou celles de la liste + "*ColNames*"), le vecteur est de type "*Vector*". .. index:: single: setObservationError @@ -566,9 +580,9 @@ externes au cas. Cette commande permet de lire ou charger un cas d'étude, à partir d'un fichier "*FileName*" ou d'un contenu en mémoire par "*Content*" ou "*Object*". Le mot-clé "*Formater*" peut désigner le format "*TUI*" pour - les commandes du type interface de programmation textuelle, et le format - "*COM*" pour les commandes du type COMM provenant de l'interface ADAO de - type EFICAS. + les commandes du type interface de programmation textuelle (défaut), et le + format "*COM*" pour les commandes du type COMM provenant de l'interface + ADAO de type EFICAS. .. index:: single: dump @@ -576,7 +590,7 @@ externes au cas. Cette commande permet d'enregistrer, dans un fichier "*FileName*", les commandes du cas d'étude en cours. Le mot-clé "*Formater*" peut désigner les formats "*TUI*" pour les commandes du type interface de programmation - textuelle, et "*YACS*" pour les commandes du type YACS. + textuelle (défaut), et "*YACS*" pour les commandes du type YACS. .. index:: single: convert .. index:: single: FileNameFrom