From 918655e09a1edcda20defc79861d1911bb46558c Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Sun, 28 Sep 2014 03:39:46 +0200 Subject: [PATCH] Documentation minor corrections and improvements --- doc/en/advanced.rst | 16 +++++++++++----- doc/en/theory.rst | 11 +++++++---- doc/fr/advanced.rst | 16 +++++++++++----- doc/fr/ref_operator_requirements.rst | 2 +- doc/fr/theory.rst | 9 ++++++--- 5 files changed, 36 insertions(+), 18 deletions(-) diff --git a/doc/en/advanced.rst b/doc/en/advanced.rst index 632612e..1a5983d 100644 --- a/doc/en/advanced.rst +++ b/doc/en/advanced.rst @@ -40,7 +40,7 @@ It is possible to convert and execute an ADAO command file (JDC, or ".comm/.py" files pair, which resides in ````) automatically by using a template shell script containing all the required steps. The user has to know where are the main SALOME launching files, and in particular the -``runAppli`` one. The directory in which this script resides is symbolically +``salome`` one. The directory in which this script resides is symbolically named ```` and has to be replaced by the good one in the shell file template. @@ -62,12 +62,12 @@ The template of the shell script is the following:: #!/bin/bash export USERDIR= export SALOMEDIR= - $SALOMEDIR/runAppli -k -t - $SALOMEDIR/runSession python \ + $SALOMEDIR/salome start -k -t + $SALOMEDIR/salome shell python \ $SALOMEDIR/bin/salome/AdaoYacsSchemaCreator.py \ $USERDIR/ $USERDIR/ - $SALOMEDIR/runSession driver $USERDIR/ - $SALOMEDIR/runSession killSalome.py + $SALOMEDIR/salome shell driver $USERDIR/ + $SALOMEDIR/salome shell killSalome.py rm -f $USERDIR/ Standard output and errors come on console. @@ -161,6 +161,8 @@ printing, statistical treatment, etc. Getting more information when running a calculation --------------------------------------------------- +.. index:: single: Logging + When running a calculation, useful data and messages are logged. There are two ways to obtain theses information. @@ -193,6 +195,8 @@ level is chosen (that is, even if these variables are not printed). Accelerating numerical derivatives calculations by using a parallel mode ------------------------------------------------------------------------ +.. index:: single: EnableMultiProcessing + When setting an operator, as described in :ref:`section_reference`, the user can choose a functional form "*ScriptWithOneFunction*". This form explicitly leads to approximate the tangent and adjoint operators by a finite differences @@ -241,6 +245,8 @@ operator function before and during enabling parallelism... Switching from a version of ADAO to a newer one ----------------------------------------------- +.. index:: single: Version + The ADAO module and its ".comm" case files are identified by versions, with "Major", "Minor" and "Revision" characteristics. A particular version is numbered as "Major.Minor.Revision", with strong link with the numbering of the diff --git a/doc/en/theory.rst b/doc/en/theory.rst index 3655800..ad7e8a7 100644 --- a/doc/en/theory.rst +++ b/doc/en/theory.rst @@ -139,9 +139,12 @@ Simple description of the data assimilation methodological framework .. index:: single: background error covariances .. index:: single: observation error covariances .. index:: single: covariances +.. index:: single: 3DVAR +.. index:: single: Blue We can write these features in a simple manner. By default, all variables are -vectors, as there are several parameters to readjust. +vectors, as there are several parameters to readjust, or a discrete field to +reconstruct. According to standard notations in data assimilation, we note :math:`\mathbf{x}^a` the optimal parameters that is to be determined by @@ -317,9 +320,9 @@ example, we can cite *absolute error value*, *maximum error value*, etc. These error measures are not differentiables, but some optimization methods can deal with: heuristics and meta-heuristics for real-valued problem, etc. As previously, the main drawback remain a greater numerical cost to find state -estimates, and no guarantee of convergence in finite time. Here, we point also -the following methods as it is available in the ADAO module: *Particle swarm -optimization* [WikipediaPSO]_. +estimates, and no guarantee of convergence in finite time. Here again, we only +point the following methods as it is available in the ADAO module: *Particle +swarm optimization* [WikipediaPSO]_. The reader interested in the subject of optimization can look at [WikipediaMO]_ as a general entry point. diff --git a/doc/fr/advanced.rst b/doc/fr/advanced.rst index b4a2d50..7e14374 100644 --- a/doc/fr/advanced.rst +++ b/doc/fr/advanced.rst @@ -41,7 +41,7 @@ paire de fichiers ".comm/.py", qui se trouvent dans le r du fichier JDC ADAO>``) automatiquement en utilisant un script de commandes shell "type" contenant toutes les étapes requises. L'utilisateur doit savoir où se trouvent les principaux fichiers de lancement de SALOME, et en particulier le -fichier ``runAppli``. Le répertoire dans lequel ce fichier réside est +fichier ``salome``. Le répertoire dans lequel ce fichier réside est symboliquement nommé ```` et doit être remplacé par le bon dans le modèle "type" de fichier shell. @@ -66,12 +66,12 @@ Le mod #!/bin/bash export USERDIR= export SALOMEDIR= - $SALOMEDIR/runAppli -k -t - $SALOMEDIR/runSession python \ + $SALOMEDIR/salome start -k -t + $SALOMEDIR/salome shell python \ $SALOMEDIR/bin/salome/AdaoYacsSchemaCreator.py \ $USERDIR/ $USERDIR/ - $SALOMEDIR/runSession driver $USERDIR/ - $SALOMEDIR/runSession killSalome.py + $SALOMEDIR/salome shell driver $USERDIR/ + $SALOMEDIR/salome shell killSalome.py rm -f $USERDIR/ Les sorties standard et d'erreur se font à la console. @@ -169,6 +169,8 @@ graphique, de stockage, d'affichage complexe, de traitement statistique, etc. Obtenir plus d'information lors du déroulement d'un calcul ---------------------------------------------------------- +.. index:: single: Logging + Lors du déroulement d'un calcul, des données et messages utiles sont disponibles. Il y a deux manières d'obtenir ces informations. @@ -204,6 +206,8 @@ variables ne sont pas affich Accélérer les calculs de dérivées numériques en utilisant un mode parallèle --------------------------------------------------------------------------- +.. index:: single: EnableMultiProcessing + Lors de la définition d'un opérateur, comme décrit dans la chapitre :ref:`section_reference`, l'utilisateur peut choisir la forme fonctionnelle "*ScriptWithOneFunction*". Cette forme conduit explicitement à approximer les @@ -257,6 +261,8 @@ parall Passer d'une version d'ADAO à une nouvelle ------------------------------------------ +.. index:: single: Version + Le module ADAO et ses fichiers de cas ".comm" sont identifiés par des versions, avec des caractéristiques "Major", "Minor" et "Revision". Une version particulière est numérotée "Major.Minor.Revision", avec un lien fort avec la diff --git a/doc/fr/ref_operator_requirements.rst b/doc/fr/ref_operator_requirements.rst index a533fbe..6934e42 100644 --- a/doc/fr/ref_operator_requirements.rst +++ b/doc/fr/ref_operator_requirements.rst @@ -200,7 +200,7 @@ d Toutefois, si vous souhaitez utiliser cette troisième forme, on recommande de se baser sur le modèle suivant pour le script d'aiguillage. Il nécessite un fichier script ou un code externe nommé ici "*Physical_simulation_functions.py*", -contenant trois fonctions nommées "*DirectOperator*", "*TangentOperator*" and +contenant trois fonctions nommées "*DirectOperator*", "*TangentOperator*" et "*AdjointOperator*" comme précédemment. Voici le squelette d'aiguillage:: import Physical_simulation_functions diff --git a/doc/fr/theory.rst b/doc/fr/theory.rst index b33fc1a..75e726f 100644 --- a/doc/fr/theory.rst +++ b/doc/fr/theory.rst @@ -148,9 +148,12 @@ Description simple du cadre m .. index:: single: covariances d'erreurs d'ébauche .. index:: single: covariances d'erreurs d'observation .. index:: single: covariances +.. index:: single: 3DVAR +.. index:: single: Blue On peut décrire ces démarches de manière simple. Par défaut, toutes les -variables sont des vecteurs, puisqu'il y a plusieurs paramètres à ajuster. +variables sont des vecteurs, puisqu'il y a plusieurs paramètres à ajuster, ou un +champ discretisé à reconstruire. Selon les notations standard en assimilation de données, on note :math:`\mathbf{x}^a` les paramètres optimaux qui doivent être déterminés par @@ -325,7 +328,7 @@ principal d supérieur pour trouver les estimations d'états, et pas de garantie de convergence en temps fini. Ici, on ne mentionne que des méthodes qui sont disponibles dans le module ADAO : la *régression de quantile (Quantile -Regression)* [WikipediaQR]_ and l'*optimisation par essaim de particules +Regression)* [WikipediaQR]_ et l'*optimisation par essaim de particules (Particle Swarm Optimization)* [WikipediaPSO]_. En second lieu, les méthodes d'optimisation cherchent usuellement à minimiser @@ -340,7 +343,7 @@ certaines m méta-heuristiques pour les problèmes à valeurs réelles, etc. Comme précédemment, le principal désavantage de ces méthodes est un coût numérique souvent bien supérieur pour trouver les estimations d'états, et pas de garantie de -convergence en temps fini. Ici, on ne mentionne encore que des méthodes qui sont +convergence en temps fini. Ici encore, on ne mentionne que des méthodes qui sont disponibles dans le module ADAO : l'*optimisation par essaim de particules (Particle Swarm Optimization)* [WikipediaPSO]_. -- 2.39.2