Salome HOME
add doc/build for EZ direct html or pdf
[tools/sat.git] / doc / build / html / _sources / commands / application.txt
1
2 .. include:: ../../rst_prolog.rst
3
4 Command application
5 *********************
6
7 Description
8 ===========
9 The **application** command creates a virtual SALOME_ application.
10 Virtual SALOME applications are used to start SALOME when distribution is needed.
11
12 Usage
13 =====
14 * Create an application: ::
15
16     sat application <application>
17     
18   Create the virtual application directory in the salomeTool application directory ``$APPLICATION.workdir``.
19
20 * Give a name to the application: ::
21
22     sat application <application> --name <my_application_name>
23
24   *Remark*: this option overrides the name given in the virtual_app section of the configuration file ``$APPLICATION.virtual_app.name``.
25
26 * Change the directory where the application is created: ::
27
28     sat application <application> --target <my_application_directory>
29
30 * Set a specific SALOME_ resources catalog (it will be used for the distribution of components on distant machines): ::
31
32     sat application <application> --catalog <path_to_catalog>
33     
34   Note that the catalog specified will be copied to the application directory.
35
36 * Generate the catalog for a list of machines: ::
37
38     sat application <application> --gencat machine1,machine2,machine3
39
40   This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
41
42 * Generate a mesa application (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): ::
43
44     sat launcher <application> --use_mesa
45
46 Some useful configuration pathes
47 =================================
48
49 The virtual application can be configured with the virtual_app section of the configutation file.
50
51 * **APPLICATION.virtual_app**
52
53   * **name** : name of the launcher (to replace the default runAppli).
54   * **application_name** : (optional) the name of the virtual application directory, if missing the default value is ``$name + _appli``.
55