doc/advanced.rst

   1 .. _section_advanced:
   2
   3 ================================================================================
   4 Advanced usage of ADAO
   5 ================================================================================
   6
   7 This section presents advanced methods to use the ADAO module, how to get more
   8 information, or how to use it without the graphical user interface (GUI).
   9
  10 Exporting an ADAO command file (JDC) to YACS in console mode
  11 --------------------------------------------------------------------------------
  12
  13 An export command can use the Python file generated by the editor used to build
  14 the ADAO command file (JDC). If the ADAO command file is named "Study1.comm",
  15 then a file named "Study1.py" can be found in the same directory. The complete
  16 procedure is the following:
  17
  18 #.      using the SALOME application including ADAO module, launch SALOME with ``./runAppli -k``
  19 #.      initialise the command line session with: ``./runSession``
  20 #.      execute the export command: ``python ${ADAO_ROOT_DIR}/bin/salome/AdaoYacsSchemaCreator.py <input Python file> <output YACS xml scheme>``
  21 #.      standard output comes on console, successive executions can be done
  22 #.      stop SALOME:  ``shutdownSalome.py`` or ``killSalome.py``
  23 #.      exit from the session: ``CTRL+D``
  24
  25 Be careful, if the output YACS xml scheme already exists, this command replace
  26 it without asking the user. The command accepts files with or without path
  27 specifications.
  28
  29 It is not necessary to launch and shut down SALOME each time if the application
  30 is already running.
  31
  32 Running an ADAO calculation scheme in YACS in console mode
  33 --------------------------------------------------------------------------------
  34
  35 This section describes how to execute in console mode a YACS calculation scheme,
  36 obtained using the ADAO "Export to YACS" function. It uses the standard YACS
  37 console mode, which will be briefly recall here (see YACS documentation for more
  38 information).
  39
  40 The way to do that is as follows:
  41
  42 #.      using the SALOME application including ADAO module, launch SALOME with ``./runAppli -k``
  43 #.      initialise the command line session with: ``./runSession``
  44 #.      change to the YACS calculation scheme directory to be executed
  45 #.      execute the YACS supervisor:  ``driver <ADAO YACS xml scheme>``
  46 #.      standard output comes on console, successive executions can be done
  47 #.      stop SALOME:  ``shutdownSalome.py`` or ``killSalome.py``
  48 #.      exit from the session: ``CTRL+D``
  49
  50 It is not necessary to launch and shut down SALOME each time if the application
  51 is already running.
  52
  53 Getting more information when running an assimilation calculation
  54 --------------------------------------------------------------------------------
  55
  56 --TODO--
  57
  58 (Use the logging functionality of the library)
  59
  60
  61 Complex time or step treatments during an assimilation calculation
  62 --------------------------------------------------------------------------------
  63
  64 --TODO--
  65
  66 (Scheduling input data)