doc/using.rst

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