doc/src/commands/launcher.rst

   1
   2 .. include:: ../../rst_prolog.rst
   3
   4 Command launcher
   5 ******************
   6
   7 Description
   8 ===========
   9 The **launcher** command creates a SALOME launcher, a python script file to start SALOME_.
  10
  11
  12 Usage
  13 =====
  14 * Create a launcher: ::
  15
  16     sat launcher <application>
  17
  18   Generate a launcher in the application directory, i.e ``$APPLICATION.workdir``.
  19
  20 * Create a launcher with a given name (default name is ``APPLICATION.profile.launcher_name``) ::
  21
  22     sat launcher <application> --name ZeLauncher
  23
  24   The launcher will be called *ZeLauncher*.
  25
  26 * Set a launcher which does not initialise the PATH variables: ::
  27
  28     sat launcher <application>  --no_path_init
  29
  30   In this case the launcher does not initialise the path variables (the default is to do it only for PATH, not for LD_LIBRARY_PATH, PYTHONPATH, etc).
  31
  32 * Create a generic launcher, which sets the environment (bash or bat) and call the exe given as argument: ::
  33
  34     sat launcher <application> -e INSTALL/SALOME/bin/salome/salome.py -n salome.sh
  35
  36   The launcher will be called salome.sh. It will source the environment and call ``$APPLICATION.workdir``/INSTALL/SALOME/bin/salome/salome.py.
  37   The arguments given to salome.sh are transferred to salome.py.
  38
  39 * Set a specific resources catalog: ::
  40
  41     sat launcher <application>  --catalog  <path of a salome resources catalog>
  42
  43   Note that the catalog specified will be copied to the profile directory.
  44
  45 * Generate the catalog for a list of machines: ::
  46
  47     sat launcher <application> --gencat <list of machines>
  48
  49   This will create a catalog by querying each machine (memory, number of processors) with ssh.
  50
  51 * Generate a mesa launcher (if mesa and llvm are parts of the application). Use this option only if you have to use salome through ssh and have problems with ssh X forwarding of OpengGL modules (like Paravis): ::
  52
  53     sat launcher <application> --use_mesa
  54
  55 * Generate the environment files only with the given products:
  56
  57   .. code-block:: bash
  58
  59     # This will create a launcher file called salome-pre,
  60     # which will contain GEOM,SMESH and their prerequisites.
  61     # It is useful if you want to create a launcher with only a part of Salome
  62     sat launcher  <application> --product GEOM,SMESH -n salome-pre
  63
  64
  65 Configuration
  66 =============
  67
  68 Some useful configuration paths:
  69
  70 * **APPLICATION.profile**
  71
  72   * **product** : the name of the profile product (the product in charge of holding the application stuff, like logos, splashscreen)
  73   * **launcher_name** : the name of the launcher.
  74