From 9ceb35367c5e3018669815d163b41ed8952f6c39 Mon Sep 17 00:00:00 2001 From: Jean-Philippe ARGAUD Date: Fri, 14 Jun 2013 14:37:35 +0200 Subject: [PATCH] Documenting editable observer templates --- doc/advanced.rst | 9 +++++++-- doc/reference.rst | 6 +++--- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/advanced.rst b/doc/advanced.rst index b462aea..f7d2cec 100644 --- a/doc/advanced.rst +++ b/doc/advanced.rst @@ -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] diff --git a/doc/reference.rst b/doc/reference.rst index 1f63ba4..be3aa97 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -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 -- 2.39.2