]> SALOME platform Git repositories - modules/jobmanager.git/blob - doc/jobmanager_gui.rst
Salome HOME
Merge branch 'V9_13_BR'
[modules/jobmanager.git] / doc / jobmanager_gui.rst
1 Using the JOBMANAGER GUI
2 ========================
3
4 Job management with the GUI
5 ---------------------------
6
7 This section describes the parts 1 and 2 (described in the introduction section) of the JOBMANAGER GUI 
8 dedicated to the management of jobs.
9
10 JOBMANAGER provides some buttons to manage the user job list (see figure :ref:`figure_jobmanager_main_buttons`).
11
12 .. _figure_jobmanager_main_buttons:
13
14 .. figure:: images/jobmanager_main_buttons.png
15   :align: center
16
17   **Main buttons for job management and job list**
18
19 The description of each button (framed in blue in the figure) is given in the table below. 
20
21 ======================== ============================ ================================================================ ===================
22 **Button**               **Condition of activation**  **Description**                                                  **Multi Selection**
23 ======================== ============================ ================================================================ ===================
24 **Create**               Always activated             Launch the job wizard to create a job.                           Not matter
25 **Start**                Job selected and job state   Start a job.                                                     No
26                          equals to *Created*
27 **Get Results**          Job selected and job state   Get job results in the result directory.                         Yes
28                          equals to *Finish* or 
29                          *Failed*
30 **Stop**                 Job selected and job state   Stop the job. If the job is registered into a remote batch       Yes
31                          equals to *Queued* or        manager, it is removed from it.
32                          *Running* or *Paused*
33 **Delete**               Job selected                 Delete a job. If the job is registered into a remote batch       Yes
34                                                       manager, it is removed from it.
35 **Restart**              Job selected and job state   Restart a job.                                                   No
36                          equals to *Finish* or 
37                          *Failed*
38 **Edit/Clone**           Job selected                 Edit a job in *created* or *Error* or *Failed* or *Not Created*  No
39                                                       state. Clone a job in other state.
40 **Refresh jobs**         Always activated             Update jobs states.                                              Not matter
41 ======================== ============================ ================================================================ ===================
42
43 **Tip:** You could use the **Auto Refresh** button in GUI part 3 to enable an automatic refresh.
44
45 When a job is selected, the part 2 is filled with all the information that the JOBMANAGER has on the job. The figure
46 :ref:`figure_jobmanager_job_focus` shows this part of the GUI. It contains two tabs. The first tab provides the main 
47 information and the run information. The second tab shows the input and output file list of the job.
48
49 .. _figure_jobmanager_job_focus:
50
51 .. figure:: images/jobmanager_job_focus.png
52   :align: center
53
54   **Job widget information**
55
56 Job creation workflow
57 ---------------------
58
59 This section describes the workflow when a job is created. The jobmanager uses a wizard to create a job.
60
61 The first page (see :ref:`figure_jobmanager_job_workflow_1`) of the wizard permits to define the **job name** 
62 and the **job type**. For each job type, the page provides an explanation of what job type refers.
63
64 .. _figure_jobmanager_job_workflow_1:
65
66 .. figure:: images/jobmanager_job_workflow_1.png
67   :align: center
68
69   **Create wizard page 1**
70
71 The second page (see :ref:`figure_jobmanager_job_workflow_2`) permits to add two files, the main job file 
72 (in this example a command file). You could also add an environment file that is not mandatory.
73
74 .. _figure_jobmanager_job_workflow_2:
75
76 .. figure:: images/jobmanager_job_workflow_2.png
77   :align: center
78
79   **Create wizard page 2**
80
81 The third page (see :ref:`figure_jobmanager_job_workflow_5`) permits to choose the resource where the job 
82 will be executed. You can also define the batch queue that you want to use.
83
84 .. _figure_jobmanager_job_workflow_5:
85
86 .. figure:: images/jobmanager_job_workflow_5.png
87   :align: center
88
89   **Create wizard page 3**
90
91 The fourth page (see :ref:`figure_jobmanager_job_workflow_3`) allows to define the resource requirements
92 and limits for the job. You can define the maximum duration,
93 the amount of memory needed (per node or per core if the batch manager supports it), the number of
94 processors/cores for the job, and whether it should use nodes exclusively (not sharing them with other
95 jobs). Time and memory requirements can be set to a "Default" value, which is the default for the
96 selected cluster and queue.
97
98 .. _figure_jobmanager_job_workflow_3:
99
100 .. figure:: images/jobmanager_job_workflow_3.png
101   :align: center
102
103   **Create wizard page 4**
104
105 The fifth page (see :ref:`figure_jobmanager_job_workflow_4`) permits to add the input and output files. 
106 Input files are files located into the user
107 computer that have to be transferred into the execution resource. Output files will be copied to the user
108 computer at the end of the job.
109 It's mandatory to define the *Remote working directory* that is the directory where the job will be executed.
110 Note that if a working directory is defined for the selected resource, the working directory for the job will be
111 created as a subdirectory of the resource working directory by default. The name of this subdirectory will
112 contain the current date and time. Of course, you can override this default value.
113 Input files will be copied in this working directory.
114 In this page, you can also define the result directory where the job's results and logs will be copied.
115
116 .. _figure_jobmanager_job_workflow_4:
117
118 .. figure:: images/jobmanager_job_workflow_4.png
119   :align: center
120
121   **Create wizard page 5**
122
123 The sixth page (see :ref:`figure_jobmanager_job_workflow_advanced`) can be
124 used to define some advanced parameters, which are generally optional. The
125 field "Workload Characterization Key" is used on some clusters to associate
126 each job with a project for instance. The field "Extra parameters" can be used
127 to specify some other parameters or environment variables that are not
128 available through the JOBMANAGER interface. The content of this field is added
129 "as is" in the job submission file.
130
131 .. _figure_jobmanager_job_workflow_advanced:
132
133 .. figure:: images/jobmanager_job_workflow_advanced.png
134   :align: center
135
136   **Create wizard page 6**
137
138 The last page (see :ref:`figure_jobmanager_job_workflow_6`) finalizes the job creation. You could choose 
139 if you want or not start the job at the end of the wizard.
140
141 .. _figure_jobmanager_job_workflow_6:
142
143 .. figure:: images/jobmanager_job_workflow_6.png
144   :align: center
145
146   **Create wizard page 7**
147
148 Loading and saving job list
149 ---------------------------
150
151 The JOBMANAGER permits to save and load the job list.
152 For some jobs, this feature permits to follow the execution of a job
153 into a different SALOME session by loading the list.
154
155 The figure :ref:`figure_jobmanager_load_save_buttons` shows where are located 
156 the load and save buttons in the JOBMANAGER GUI.
157
158 .. _figure_jobmanager_load_save_buttons:
159
160 .. figure:: images/jobmanager_load_save_buttons.png
161   :align: center
162
163   **Location of load and save job list buttons**
164
165 All jobs cannot be followed between two SALOME sessions. Indeed, It's the *batch* type
166 of the resource that allows to know if you can or not follow a job. Currently, resources
167 that use **ssh** for batch configuration cannot be followed. In this case, when the JOBMANAGER
168 load the job, it will set this kind of job in the **Error** state.
169