From: Jean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Date: Thu, 29 Mar 2012 14:08:20 +0000 (+0200)
Subject: Adding a glossary
X-Git-Tag: V6_5_0~20^2
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=06951488afed2137a51c1fe6039e58d23a6aba08;p=modules%2Fadao.git

Adding a glossary
---

diff --git a/doc/glossary.rst b/doc/glossary.rst
new file mode 100644
index 0000000..ca09ccb
--- /dev/null
+++ b/doc/glossary.rst
@@ -0,0 +1,22 @@
+.. _section_glossary:
+
+Glossary
+========
+
+.. glossary::
+   :sorted:
+
+   case
+      One case is defined by a set of data and of choices, packed together
+      through the user interface of the module. The data are physical
+      measurements that have to be available before or during the case
+      execution. The simulation code(s) and the assimilation methods and
+      parameters has to be chosen, they define the execution properties of the
+      case.
+
+   iteration
+      One iteration occurs when using iterative optimizers (e.g. 3DVAR), and it
+      is entirely hidden in the main YACS OptimizerLoop Node named
+      "compute_bloc". Nevertheless, the user can watch the iterative process
+      throught the *YACS Container Log* window, which is updated during the
+      process, and using *Observers* attached to calculation variables.