]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Documentation minor corrections and improvements
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Wed, 10 Sep 2014 09:04:33 +0000 (11:04 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Wed, 10 Sep 2014 09:04:33 +0000 (11:04 +0200)
doc/en/images/adao_algopar_script.png [new file with mode: 0644]
doc/en/images/adao_algopar_string.png [new file with mode: 0644]
doc/en/ref_covariance_requirements.rst
doc/en/ref_options_AlgorithmParameters.rst
doc/fr/images/adao_algopar_script.png [new file with mode: 0644]
doc/fr/images/adao_algopar_string.png [new file with mode: 0644]
doc/fr/ref_covariance_requirements.rst
doc/fr/ref_options_AlgorithmParameters.rst

diff --git a/doc/en/images/adao_algopar_script.png b/doc/en/images/adao_algopar_script.png
new file mode 100644 (file)
index 0000000..e19b6ef
Binary files /dev/null and b/doc/en/images/adao_algopar_script.png differ
diff --git a/doc/en/images/adao_algopar_string.png b/doc/en/images/adao_algopar_string.png
new file mode 100644 (file)
index 0000000..bc4bf2d
Binary files /dev/null and b/doc/en/images/adao_algopar_string.png differ
index fe64eba7eedb7dff9a3ba03d6ef01cc58cad9e4c..30c7464e4d48be9b052e1ab3bcd8954dfa616794 100644 (file)
@@ -32,8 +32,8 @@ matrix, noted as :math:`\mathbf{B}`, and the observation error covariance matrix
 noted as :math:`\mathbf{R}`. Such a matrix is required to be a squared symmetric
 semi-definite positive matrix.
 
-There are 3 practical methods for the user to provide a covariance matrix. These
-methods are chosen by the "*INPUT_TYPE*" keyword of each defined covariance
+There are 3 practical methods for the user to provide a covariance matrix. The
+method is chosen by the "*INPUT_TYPE*" keyword of each defined covariance
 matrix, as shown by the following figure:
 
   .. eficas_covariance_matrix:
index 151b482b9ab95b174a3cb51aea7047041c792bfb..bfbc92217cee1e25d47e0cc568af523e8ff4cc01 100644 (file)
 Description of options of an algorithm by "*AlgorithmParameters*"
 -----------------------------------------------------------------
 
-Each algorithm can be controlled using some generic or specific options, given
-through the "*AlgorithmParameters*" optional command in a script file or a
-string, as follows for example in a Python file::
+Each algorithm can be controlled using some specific options, given through the
+"*AlgorithmParameters*" optional command.
+
+There are 2 practical methods for the user to provide these options. The
+method is chosen by the keyword "*FROM*", included in the entry
+"*AlgorithmParameters*" in EFICAS.
+
+If an option is specified by the user for an algorithm that doesn't support it,
+the option is simply left unused and don't stop the treatment. The meaning of
+the acronyms or particular names can be found in the :ref:`genindex` or the
+:ref:`section_glossary`.
+
+First method : using a string in EFICAS
++++++++++++++++++++++++++++++++++++++++
+
+To give the values for the command "*AlgorithmParameters*" as a string, directly
+in the EFICAS graphical interface, the user selects this type in the keyword
+"*FROM*", as shown in the following figure:
+
+  .. :adao_algopar_string
+  .. image:: images/adao_algopar_string.png
+    :align: center
+    :width: 100%
+  .. centered::
+    **Using a string for algorithmic parameters**
+
+In the entry, one must enclose a standard dictionary definition between simple
+quotes, as for example::
+
+    '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
+
+It is the recommended way to define algorithmic parameters.
+
+Second method : using an external Python script file
+++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+To give the values for the command "*AlgorithmParameters*" in an external Python
+script file, the user selects in EFICAS this type in the keyword "*FROM*", as
+shown in the following figure:
+
+  .. :adao_algopar_script
+  .. image:: images/adao_algopar_script.png
+    :align: center
+    :width: 100%
+  .. centered::
+    **Using an external file for algorithmic parameters**
+
+This external Python script file has then to define a variable with the required
+name "*AlgorithmParameters*", as in the following example::
 
     AlgorithmParameters = {
         "StoreInternalVariables" : True,
@@ -37,13 +83,4 @@ string, as follows for example in a Python file::
         "StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
         }
 
-To give the "*AlgorithmParameters*" values by a string, directly in the EFICAS
-interface, one must enclose a standard dictionary definition between simple
-quotes, as for example::
-
-    '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
-
-If an option is specified by the user for an algorithm that doesn't support it,
-the option is simply left unused and don't stop the treatment. The meaning of
-the acronyms or particular names can be found in the :ref:`genindex` or the
-:ref:`section_glossary`.
+The file can also contain other Python commands.
diff --git a/doc/fr/images/adao_algopar_script.png b/doc/fr/images/adao_algopar_script.png
new file mode 100644 (file)
index 0000000..e19b6ef
Binary files /dev/null and b/doc/fr/images/adao_algopar_script.png differ
diff --git a/doc/fr/images/adao_algopar_string.png b/doc/fr/images/adao_algopar_string.png
new file mode 100644 (file)
index 0000000..bc4bf2d
Binary files /dev/null and b/doc/fr/images/adao_algopar_string.png differ
index cafd48e2773f65ffdf4f48e4c3f07ed164a990f3..81538caac547be71676f8cf47b1e30e670b4b24e 100644 (file)
@@ -33,8 +33,8 @@ matrice de covariance des erreurs d'observation, not
 telle matrice doit être une matrice carré symétrique semi-définie positive.
 
 Il y a 3 méthodes pratiques pour l'utilisateur pour fournir une matrice de
-covariance. Ces méthodes sont choisies à l'aide du mot-clé "*INPUT_TYPE*" de
-chaque matrice de covariance, comme montré dans la figure qui suit :
+covariance. La méthode est choisie à l'aide du mot-clé "*INPUT_TYPE*" de chaque
+matrice de covariance, comme montré dans la figure qui suit :
 
   .. eficas_covariance_matrix:
   .. image:: images/eficas_covariance_matrix.png
index 2ca0e143e20a5e74a19d8d2975cf38bb33631583..87173eb672d8246656d4dd9d8b2a194116d4f252 100644 (file)
@@ -28,8 +28,55 @@ Description des options d'un algorithme par "*AlgorithmParameters*"
 -------------------------------------------------------------------
 
 Chaque algorithme peut être contrôlé en utilisant des options particulières,
-données à travers la commande optionnelle "*AlgorithmParameters*", à la manière
-de l'exemple qui suit, dans un fichier Python::
+données à travers la commande optionnelle "*AlgorithmParameters*".
+
+Il y a 2 méthodes pratiques pour l'utilisateur pour fournir ces options. La
+méthode est choisie à l'aide du mot-clé "*FROM*", inclus dans l'entrée
+"*AlgorithmParameters*" dans EFICAS.
+
+Si une option est spécifiée par l'utilisateur pour un algorithme qui ne la
+supporte pas, cette option est simplement laissée inutilisée et ne bloque pas le
+traitement. La signification des acronymes ou des noms particuliers peut être
+trouvée dans l':ref:`genindex` ou dans le :ref:`section_glossary`.
+
+Première méthode : utiliser une chaîne de caractères dans EFICAS
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Pour donner les valeurs de la commande "*AlgorithmParameters*" par une chaîne de
+caractères, directement dans l'interface graphique EFICAS, l'utilisateur
+sélectionne ce type dans le mot-clé "*FROM*", comme montré dans la figure qui
+suit :
+
+  .. adao_algopar_string:
+  .. image:: images/adao_algopar_string.png
+    :align: center
+    :width: 100%
+  .. centered::
+    **Utiliser une chaîne de caractères pour les paramètres algorithmiques**
+
+Dans le champs de saisie, il faut utiliser des guillemets simples pour une
+définition standard de dictionnaire, comme par exemple::
+
+    '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
+
+C'est la manière recommandée pour définir des paramètres algorithmiques.
+
+Seconde méthode : utiliser un fichier de script Python externe
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+Pour donner les valeurs de la commande "*AlgorithmParameters*" par un fichier de
+script Python externe, l'utilisateur sélectionne dans EFICAS ce type dans le
+mot-clé "*FROM*", comme montré dans la figure qui suit :
+
+  .. :adao_algopar_script
+  .. image:: images/adao_algopar_script.png
+    :align: center
+    :width: 100%
+  .. centered::
+    **Utiliser un fichier externe pour les paramètres algorithmiques**
+
+Ce fichier script Python externe doit définir alors une variable au nom imposé
+"*AlgorithmParameters*", à la manière de l'exemple qui suit::
 
     AlgorithmParameters = {
         "StoreInternalVariables" : True,
@@ -37,14 +84,4 @@ de l'exemple qui suit, dans un fichier Python::
         "StoreSupplementaryCalculations" : ["APosterioriCovariance","OMA"],
         }
 
-Pour donner les valeurs de la commande "*AlgorithmParameters*" par une chaîne de
-caractères, directement dans l'interface EFICAS, on doit utiliser des guillemets
-simples pour fournir une définition standard de dictionnaire, comme par
-exemple::
-
-    '{"StoreInternalVariables":True,"MaximumNumberOfSteps":25}'
-
-Si une option est spécifiée par l'utilisateur pour un algorithme qui ne la
-supporte pas, cette option est simplement laissée inutilisée et ne bloque pas le
-traitement. La signification des acronymes ou des noms particuliers peut être
-trouvée dans l':ref:`genindex` ou dans le :ref:`section_glossary`.
+Le fichier peut aussi contenir d'autres commandes Python.