doc/advanced.rst

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