par_keys.sort()
algo_parameters = ""
for pn in par_keys:
- if pn in ("StoreInternalVariables",): continue # Cles a supprimer
+ if pn in ("StoreInternalVariables", "PlotAndSave", "ResultFile", "ResultTitle", "ResultLabel"): continue # Cles a supprimer
pt = par_dict[pn]["typecast"]
pd = par_dict[pn]["default"]
pm = par_dict[pn]["message"]
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
+reference documentation (indicated in the title by **[DocR]**).
+
+The first part is the :ref:`section_intro`. 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 part indicate
-:ref:`section_advanced`, with obtaining additional information or the use of
+come back regularly to the third and seventh parts. The fifth part indicates the
+:ref:`section_advanced`, with how to obtain additional information or how to use
non-GUI execution scripting. The next part gives a detailed
:ref:`section_reference`, with four main sub-parts following, the last one
giving a :ref:`section_tui` of the module. And, to respect the module
See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
-In addition, we expect that all publication or presentation describing work
+In addition, we require 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/
- * *ADAO, un module SALOME pour l'Assimilation de Donnees et l'Aide a
+ * *ADAO, un module SALOME pour l'Assimilation de Données et l'Aide à
l'Optimisation*, http://www.salome-platform.org/
* *SALOME The Open Source Integration Platform for Numerical Simulation*,
To clarify and facilitate the use of the module for scripting, **this section
therefore defines the application programming interface (API) for textual user
-interface (TUI) a comprehensive and restricted manner**. Use in scripts of ADAO
-objects or functions other than those defined here is strongly discouraged, as
-this will likely lead to crashes without warning in future versions.
+interface (TUI) by a comprehensive and restricted manner**. Use in scripts of
+ADAO objects or functions other than those defined here is strongly discouraged,
+as this will likely lead to crashes without warning in future versions.
Equivalent syntax calls for commands
++++++++++++++++++++++++++++++++++++
Indeed, for a TUI calculation case, the quantity given in entries are often
available in the current name space of the case.
-The available commands are::
+The available commands are:
.. index:: single: setBackground
**executePythonScheme** ()
This command launches the complete calculation in the environment of the
- current Python interpreter, without interaction with YACS.The standard
- output and standard error are those of the Python interpreter. If
+ current Python interpreter, without interaction with YACS [YACS]_. The
+ standard output and standard error are those of the Python interpreter. If
necessary, the internal parallelism, of the algorithms in ADAO and of the
simulation code used, is available.
visualization. Its argument the name of a variable "*Concept*" and returns
back the quantity as a list (even if there is only one specimen) of this
base variable. For a list of variables and use them, the user has to refer
- to the ':ref:`subsection_r_o_v_Inventaire` and more generally to the
+ to the :ref:`subsection_r_o_v_Inventaire` and more generally to the
:ref:`section_ref_output_variables` and to the individual documentations of
the algorithms.
#. that we want to adjust 3 parameters ``alpha``, ``beta`` and ``gamma`` in a bounded domain,
#. that we dispose of observations named ``observations``,
-#. that the user have a Python function of physical simulation named ``simulation`` previously tested, which transforms the 3 parameters in results similar to the observations,
+#. that the user have a Python function of physical simulation named ``simulation``, previously (well) tested, which transforms the 3 parameters in results similar to the observations,
#. that the independent holding, that the user want to elaborate, is represented here by the simple printing of the initial state, of the optimal state, of the simulation in that point, of the intermediate state and of the number of optimization iteration.
In order to try in a simple way this example of TUI calculation case, we choose
des informations sur leurs erreurs. Certaines des méthodes incluses dans ce
cadre sont également connues sous les noms d'*estimation des paramètres*, de
*problèmes inverses*, d'*estimation bayésienne*, d'*interpolation optimale*,
-etc. De plus amples détails peuvent être trouvés dans la partie
+etc. De plus amples détails peuvent être trouvés dans la partie proposant
:ref:`section_theory`.
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. La cinquième partie indique les :ref:`section_advanced`, avec
-l'obtention de renseignements supplémentaires ou l'usage par scripts d'exécution
-sans interface utilisateur graphique (GUI). La partie suivante détaille la
-:ref:`section_reference`, avec quatre sous-parties principales qui suivent, la
-dernière sous-partie décrivant une :ref:`section_tui` du module. Enfin, pour
-respecter les exigences de licence du module, n'oubliez pas de lire la partie
-:ref:`section_license`.
+documentation de référence (indiquée dans le titre par **[DocR]**).
+
+La première partie est l':ref:`section_intro`. La seconde partie présente
+:ref:`section_theory`, et à leurs concepts. Pour un utilisateur courant, 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. La cinquième partie
+indique les :ref:`section_advanced`, avec l'obtention de renseignements
+supplémentaires ou l'usage par scripts d'exécution sans interface utilisateur
+graphique (GUI). La partie suivante détaille la :ref:`section_reference`, avec
+quatre sous-parties principales qui suivent, la dernière sous-partie décrivant
+une :ref:`section_tui` du module. 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
See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
-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 :
+En outre, on demande 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/
**executePythonScheme** ()
Cette commande lance le calcul complet dans l'environnement de
- l'interpréteur Python courant, sans interaction avec YACS. Les sorties
- standard et d'erreur sont celles de l'interpréteur Python. On dispose si
- nécessaire du parallélisme interne des algorithmes dans ADAO et du
- parallélisme interne du ou des codes de simulation utilisé.
+ l'interpréteur Python courant, sans interaction avec YACS [YACS]_. Les
+ sorties standard et d'erreur sont celles de l'interpréteur Python. On
+ dispose si 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
..
#. que l'on veut recaler 3 paramètres ``alpha``, ``beta`` et ``gamma`` dans un domaine borné,
#. que l'on dispose d'observations nommées ``observations``,
-#. que l'utilisateur dispose en Python d'une fonction de simulation physique appellée ``simulation`` préalablement testée, qui transforme les 3 paramètres en résultats similaires aux observations,
+#. que l'utilisateur dispose en Python d'une fonction de simulation physique appellée ``simulation``, préalablement (bien) testée, qui transforme les 3 paramètres en résultats similaires aux observations,
#. que l'exploitation indépendante, que l'utilisateur veut faire, est représentée ici par l'affichage simple de l'état initial, de l'état optimal, de la simulation en ce point, des états intermédiaires et du nombre d'itérations d'optimisation.
Pour effectuer de manière simple cet essai de cas de calcul TUI, on se donne par
