Salome HOME
Merge from V6_main_20120808 08Aug12
[modules/jobmanager.git] / doc / intro.rst
1 Introduction: What is the JOBMANAGER ?
2 ======================================
3
4 The JOBMANAGER module allows creating, launching and following 
5 calculation jobs on different types of computers. 
6
7 .. figure:: images/jobmanager_overview.png
8   :scale: 75 %
9   :align: center
10
11   **Overview of the JOBMANAGER module**
12
13
14 Main functionalities
15 ++++++++++++++++++++
16
17 The JOBMANAGER module permits to define three types of jobs:
18
19 - User scripts.
20 - Python scripts launched in a SALOME session.
21 - YACS schemas.
22
23 The module handles different types of computational resources:
24
25 - Interactive computers (rsh, ssh).
26 - Clusters managed by batch systems like PBS, LSF or SGE.
27
28 User's job list could be saved and loaded. Finally, the module provides
29 an editor for managing user's SALOME resources.
30
31 General description of the GUI
32 ++++++++++++++++++++++++++++++
33
34 JOBMANAGER's GUI is divided in four parts:
35
36 - Part 1 shows the user job list. It also provides many buttons
37   to manage a job (create, delete, start, ...).
38 - Part 2 shows the parameters of the job selected in the list of part 1.
39   It's divided in two tabs. The first is for the general information, the second
40   is dedicated to the files.
41 - Part 3 provides a text widget dedicated of SALOME messages. It provides 
42   the buttons for loading or saving the job list. It also provides an auto refresh button.
43 - Part 4 is divided in two tabs. The first tab provides a summary of user's jobs status.
44   The second tab provides the SALOME resource editor.
45
46 .. figure:: images/jobmanager_overview_part.png
47   :scale: 75 %
48   :align: center
49
50   **The JOBMANAGER GUI is divided in four parts**