]> SALOME platform Git repositories - modules/jobmanager.git/commitdiff
Salome HOME
Doc update V7_5_0b1
authorRenaud Barate <renaud.barate@edf.fr>
Fri, 31 Oct 2014 09:45:48 +0000 (10:45 +0100)
committerRenaud Barate <renaud.barate@edf.fr>
Fri, 31 Oct 2014 09:45:48 +0000 (10:45 +0100)
doc/images/jobmanager_job_workflow_3.png
doc/images/jobmanager_job_workflow_advanced.png [new file with mode: 0644]
doc/job.rst
doc/jobmanager_gui.rst

index 48508f08ceb600bcd8c8b2a300a0833df02ae892..7d86ae307d3c6e97a7c182b4e4dad07821765ec1 100644 (file)
Binary files a/doc/images/jobmanager_job_workflow_3.png and b/doc/images/jobmanager_job_workflow_3.png differ
diff --git a/doc/images/jobmanager_job_workflow_advanced.png b/doc/images/jobmanager_job_workflow_advanced.png
new file mode 100644 (file)
index 0000000..d06c2e3
Binary files /dev/null and b/doc/images/jobmanager_job_workflow_advanced.png differ
index b5639e18fcae1dbab34575c81906fc0bb26cf245..d49ddb7995e85d7c271090d0d01b1f0693617985 100644 (file)
@@ -49,6 +49,8 @@ The first table below describes the attributes of a job.
 **Work directory**       Yes              It's the directory on the job's resource where the job will be executed.
 **Result directory**     Yes              It's the directory in the user computer where the job's results have to be 
                                           copied at the end of the job.
+**WC Key**               No               The Workload Characterization Key is used on some clusters to associate each
+                                          job with a project or organization.
 ======================== ================ ==============================================================================
 
 The second table below describes the attributes of computation requirements.
@@ -58,7 +60,7 @@ The second table below describes the attributes of computation requirements.
 ======================== ==============================================================================
 **Maximum duration**     It's the maximum expected duration of the job. When a batch manager is used, this
                          time is interpreted as a **walltime** and not as a **cputime**. If maximum
-                         duration is set to 0, the time will be set to the default value of the
+                         duration is not set or set to 0, the time will be set to the default value of the
                          batch queue selected.
 **Number of cpu**        It's the number of cpus/cores requested.
 **Memory**               It's the amount of required memory. It is generally specified **per node**.
@@ -70,6 +72,9 @@ The second table below describes the attributes of computation requirements.
 **Exclusive**            It indicates if the job can share nodes with other jobs or not.
 ======================== ==============================================================================
 
+In addition to those attributes, the user can also specify some extra parameters with a few lines that
+will be added "as is" to the job submission file.
+
 Job's states
 ++++++++++++
 
index dca1fe141c99b55e29d764dea8004c0bd9ecaeb8..2688c566e2d20b020646cf4ef36cec8a9bae3fc1 100644 (file)
@@ -89,11 +89,11 @@ will be executed. You can also define the batch queue that you want to use.
   **Create wizard page 3**
 
 The fourth page (see :ref:`figure_jobmanager_job_workflow_3`) allows to define the resource requirements
-and limits for the job. You can define the maximum duration
-(set 0 hours and 0 minutes to use the default value for the queue),
+and limits for the job. You can define the maximum duration,
 the amount of memory needed (per node or per core if the batch manager supports it), the number of
 processors/cores for the job, and whether it should use nodes exclusively (not sharing them with other
-jobs).
+jobs). Time and memory requirements can be set to a "Default" value, which is the default for the
+selected cluster and queue.
 
 .. _figure_jobmanager_job_workflow_3:
 
@@ -120,6 +120,21 @@ In this page, you can also define the result directory where the job's results a
 
   **Create wizard page 5**
 
+The sixth page (see :ref:`figure_jobmanager_job_workflow_advanced`) can be
+used to define some advanced parameters, which are generally optional. The
+field "Workload Characterization Key" is used on some clusters to associate
+each job with a project for instance. The field "Extra parameters" can be used
+to specify some other parameters or environment variables that are not
+available through the JOBMANAGER interface. The content of this field is added
+"as is" in the job submission file.
+
+.. _figure_jobmanager_job_workflow_advanced:
+
+.. figure:: images/jobmanager_job_workflow_advanced.png
+  :align: center
+
+  **Create wizard page 6**
+
 The last page (see :ref:`figure_jobmanager_job_workflow_6`) finalizes the job creation. You could choose 
 if you want or not start the job at the end of the wizard.
 
@@ -128,7 +143,7 @@ if you want or not start the job at the end of the wizard.
 .. figure:: images/jobmanager_job_workflow_6.png
   :align: center
 
-  **Create wizard page 6**
+  **Create wizard page 7**
 
 Loading and saving job list
 ---------------------------