]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Documenting editable observer templates
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Fri, 14 Jun 2013 12:37:35 +0000 (14:37 +0200)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Fri, 14 Jun 2013 12:37:35 +0000 (14:37 +0200)
doc/advanced.rst
doc/reference.rst

index b462aea460d6ef81940d90e57f69956efe5da8e3..f7d2cece5f5f0478dc4dd10c509530f19aeb0c3e 100644 (file)
@@ -113,8 +113,13 @@ standard inputs (available in the namespace) the variables ``var`` and ``info``.
 The variable ``var`` is to be used in the same way as for the final ADD object,
 that is as a list/tuple object.
 
-As an example, here is one very simple script used to print the value of one
-monitored variable::
+Some templates are available when editing the ADAO case in EFICAS editor. These
+simple scripts can be customized by the user, either at the EFICAS edition stage
+or at the YACS edition stage, to improve the tuning of the ADAO calculation in
+YACS.
+
+As an example, here is one very simple script (similar to the "*ValuePrinter*"
+template) used to print the value of one monitored variable::
 
     print "    --->",info," Value =",var[-1]
 
index 1f63ba402d82ee4c072e9bb253d3895b76a24cda..be3aa97c1c38e038b5341fca0860315331a340ce 100644 (file)
@@ -197,9 +197,9 @@ following:
 **Observers**
     *Optional command*. This command allows to set internal observers, that are
     functions linked with a particular variable, which will be executed each
-    time this variable is modified. It is a convenient way to monitor interest
-    variables during the data assimilation or optimization process, by printing
-    or plotting it, etc.
+    time this variable is modified. It is a convenient way to monitor variables
+    of interest during the data assimilation or optimization process, by
+    printing or plotting it, etc.
 
 **OutputVariables**
     *Optional command*. This command allows to indicates the name and size of