From: Jean-Philippe ARGAUD Date: Mon, 17 Jun 2013 13:25:22 +0000 (+0200) Subject: Documenting the existence of templates X-Git-Tag: V7_3_0~35 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=f2a096176096d4a28a89619c66178be5e80f0591;p=modules%2Fadao.git Documenting the existence of templates --- diff --git a/doc/intro.rst b/doc/intro.rst index c04b160..044a6ea 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -14,7 +14,11 @@ used throught YACS integration of ADAO. Its main objective is to *facilitate the use of various standard data assimilation or optimization methods*, while remaining easy to use and providing -a path to help the implementation. The module covers a wide variety of practical -applications in a robust way, allowing real engineering applications but also -quick experimental setup to be performed. Its methodological and numerical -scalability gives way to extend the application domain. +a path to help the implementation. For an end user, having already gathered his +physical input information, it's a matter of "point\&click" to build an ADAO +valid case and to evaluate it. + +The module covers a wide variety of practical applications in a robust way, +allowing real engineering applications but also quick experimental setup to be +performed. Its methodological and numerical scalability gives way to extend the +application domain. diff --git a/doc/reference.rst b/doc/reference.rst index be3aa97..731e12c 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -199,7 +199,8 @@ following: functions linked with a particular variable, which will be executed each 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. + printing or plotting it, etc. Common templates are provided to help the user + to start or to quickly make his case. **OutputVariables** *Optional command*. This command allows to indicates the name and size of @@ -222,7 +223,8 @@ following: *Optional command*. This commands allows to process some parameters or data automatically after data assimilation algorithm processing. It is defined as a script or a string, allowing to put post-processing code directly inside - the ADAO case. + the ADAO case. Common templates are provided to help the user to start or + to quickly make his case. Options and required commands for calculation algorithms ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ diff --git a/doc/using.rst b/doc/using.rst index 1fdbfab..3201f1d 100644 --- a/doc/using.rst +++ b/doc/using.rst @@ -149,8 +149,8 @@ to YACS. The main supplement needed in the YACS scheme is a post-processing step. The evaluation of the results has to be done in the physical context of the simulation used by the data assimilation procedure. The post-processing can be -provided through the "*UserPostAnalysis*" ADAO keyword as a script, or can be -build as YACS nodes using all SALOME possibilities. +provided through the "*UserPostAnalysis*" ADAO keyword as a script or a string, +by templates, or can be build as YACS nodes using all SALOME possibilities. The YACS scheme has an "*algoResults*" output port of the computation bloc, which gives access to a "*pyobj*" named hereafter "*ADD*", containing all the