doc/using.rst

   1 ================================================================================
   2 Using the module ADAO
   3 ================================================================================
   4
   5 This section presents the usage of the ADAO module in SALOME.
   6
   7 Logical procedure to build an ADAO test case
   8 --------------------------------------------------------------------------------
   9
  10 The construction of an ADAO case follows a simple approach to define the set of
  11 input data, either static or dynamic data, and then generates a complete block
  12 diagram used in Y. Many variations exist for the definition of input data, but
  13 the logical sequence remains unchanged.
  14
  15 First of all, the user is considered to know the input data needed to set up the
  16 data assimilation study. These data can be in SALOME or not.
  17
  18 **Basically, the procedure involves the following steps:**
  19
  20 #.      **Activate the ADAO module and use the editor GUI,**
  21 #.      **Build and modify the ADAO case and save it,**
  22 #.      **Export the ADAO case as a YACS scheme,**
  23 #.      **Modify and supplement the YACS scheme and save it,**
  24 #.      **Execute the YACS case and obtain the results.**
  25
  26 Each step will be detailed later in the next section.
  27
  28 Detailed procedure to build an ADAO test case
  29 --------------------------------------------------------------------------------
  30
  31 Activate the ADAO module and use the editor GUI
  32 ++++++++++++++++++++++++++++++++++++++++
  33
  34 As always for a module, it has to be activated by choosing the appropriate
  35 module button (or menu) in the toolbar of SALOME. A popup appears, allowing to
  36 choose between creating a new study, or opening an already existing one:
  37
  38   .. _adao_activate:
  39   .. image:: images/adao_activate.png
  40     :align: center
  41   .. centered::
  42     **Activating the module ADAO in SALOME**
  43
  44 .. |eficas_new| image:: images/eficas_new.png
  45    :align: middle
  46 .. |eficas_save| image:: images/eficas_save.png
  47    :align: middle
  48
  49 Choosing the "*New*" button, an embedded case editor EFICAS [#]_ will be opened,
  50 along with the standard "*Object browser*". You can then click on the "*New*"
  51 button |eficas_new| (or choose the "*New*" entry in the "*File*" menu) to create
  52 a new ADAO case, and you will see:
  53
  54   .. _adao_viewer:
  55   .. image:: images/adao_viewer.png
  56     :align: center
  57     :width: 100%
  58   .. centered::
  59     **The EFICAS editor for cases definition in module ADAO**
  60
  61 It is a good habit to save the ADAO case now, by pushing the "*Save*" button
  62 |eficas_save| or by choosing the "*Save/Save as*" entry in the "*File*" menu.
  63 You will be prompted for a location in your file tree and a name, that will be
  64 completed by a "*.comm*" extension used for JDC EFICAS files.
  65
  66 Build and modify the ADAO case and save it
  67 ++++++++++++++++++++++++++++++++++++++++
  68
  69 To build a case using EFICAS, you have to go through a series of steps for
  70 selecting a keyword and then filling in its value. The structured editor
  71 indicates hierarchical types, values or keywords allowed. Incomplete or
  72 incorrect keywords are identified by a visual error red flag.
  73
  74
  75
  76
  77
  78
  79 At the end, you have to save your ADAO case.
  80
  81 Export the ADAO case as a YACS scheme
  82 ++++++++++++++++++++++++++++++++++++++++
  83
  84
  85
  86 Modify and supplement the YACS scheme and save it
  87 ++++++++++++++++++++++++++++++++++++++++
  88
  89
  90 Execute the YACS case and obtain the results
  91 ++++++++++++++++++++++++++++++++++++++++
  92
  93
  94
  95
  96
  97
  98 Reference description of the commands and keywords available throught the GUI
  99 --------------------------------------------------------------------------------
 100
 101 --TODO--
 102
 103
 104 ASSIM_STUDY
 105
 106 String
 107
 108 Script
 109
 110 Vector
 111
 112 Matrix
 113
 114 Function
 115
 116 Dict
 117
 118 Background
 119
 120 BackgroundError
 121
 122 Observation
 123
 124 ObservationError
 125
 126 ObservationOperator
 127
 128 AlgorithmParameters
 129
 130 Algorithm : "ThreeDVAR", "Blue", "EnsembleBlue", "Kalman"...
 131
 132 .. [#] For more information on EFICAS, see the the *EFICAS User Guide* available in the main "*Help*" menu of SALOME GUI.
 133