Salome HOME
Observer norm complement and documentation
[modules/adao.git] / doc / en / ref_assimilation_keywords.rst
index f0a8c70d74588661431de53d1b900fd7ac518d6e..0d4e684540af452abdf63407d8d807f20bffacac 100644 (file)
@@ -43,8 +43,8 @@ List of commands and keywords for an ADAO calculation case
 .. index:: single: Observers
 .. index:: single: Observer Template
 .. index:: single: OutputVariables
-.. index:: single: Study_name
-.. index:: single: Study_repertory
+.. index:: single: StudyName
+.. index:: single: StudyRepertory
 .. index:: single: UserDataInit
 .. index:: single: UserPostAnalysis
 .. index:: single: UserPostAnalysis Template
@@ -61,18 +61,16 @@ The different commands are the following:
     assimilation or optimization case. It hierarchically contains all the other
     commands.
 
-  Algorithm
-    *Required command*. This is a string to indicate the data assimilation or
-    optimization algorithm chosen. The choices are limited and available through
-    the GUI. There exists for example "3DVAR", "Blue"... See below the list of
-    algorithms and associated parameters, each described by a subsection.
-
   AlgorithmParameters
-    *Optional command*. This command allows to add some optional parameters to
-    control the data assimilation or optimization algorithm. Its value is
-    defined as a "*Dict*" type object. See the section
-    :ref:`section_ref_options_AlgorithmParameters` for for the correct use of
-    this command.
+    *Required command*. This 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
+    specific subsection. Optionaly, 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
+    :ref:`section_ref_options_Algorithm_Parameters` for the detailed use of this
+    command part.
 
   Background
     *Required command*. This indicates the background or initial vector used,
@@ -151,11 +149,11 @@ The different commands are the following:
     physical variables that are bundled together in the output observation
     vector. This information is dedicated to data processed inside an algorithm.
 
-  Study_name
+  StudyName
     *Required command*. This is an open string to describe the ADAO study by a
     name or a sentence.
 
-  Study_repertory
+  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.