Salome HOME
spns #42205 [SAT][Windows] support different values for CMAKE_BUILD_TYPE - part III
[tools/sat.git] / doc / src / commands / application.rst
1
2 .. include:: ../../rst_prolog.rst
3
4 Command application
5 *********************
6
7 Description
8 ===========
9 The **application** command is used to create a virtual SALOME application.
10 This command use appli_gen tool to generate the virtual application.
11 It uses symbolic links and do not work on windows platform.
12
13 Usage
14 =====
15 * Create an application: ::
16
17     sat application <application>
18     
19   Create the virtual application directory in the salomeTool application directory ``$APPLICATION.workdir``.
20
21 * Give a name to the application: ::
22
23     sat application <application> --name <my_application_name>
24
25   *Remark*: this option overrides the name given in the virtual_app section of the configuration file ``$APPLICATION.virtual_app.name``.
26
27 * Change the directory where the application is created: ::
28
29     sat application <application> --target <my_application_directory>
30
31 * Set a specific SALOME resources catalog (it will be used for the distribution of components on distant machines): ::
32
33     sat application <application> --catalog <path_to_catalog>
34     
35   Note that the catalog specified will be copied to the application directory.
36
37 * Generate the catalog for a list of machines: ::
38
39     sat application <application> --gencat machine1,machine2,machine3
40
41   This will create a catalog by querying each machine through ssh protocol (memory, number of processor) with ssh.
42
43 * 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): ::
44
45     sat application <application> --use_mesa
46
47 Some useful configuration paths
48 =================================
49
50 The virtual application can be configured with the virtual_app section of the configuration file.
51
52 * **APPLICATION.virtual_app**
53
54   * **name** : name of the launcher (to replace the default runAppli).
55   * **application_name** : (optional) the name of the virtual application directory, if missing the default value is ``$name + _appli``.
56