]> SALOME platform Git repositories - modules/jobmanager.git/commitdiff
Salome HOME
More work on documentation
authorribes <ribes>
Wed, 29 Sep 2010 14:56:31 +0000 (14:56 +0000)
committerribes <ribes>
Wed, 29 Sep 2010 14:56:31 +0000 (14:56 +0000)
12 files changed:
doc/Makefile.am
doc/images/jobmanager_job_workflow_1.png [new file with mode: 0644]
doc/images/jobmanager_job_workflow_2.png [new file with mode: 0644]
doc/images/jobmanager_job_workflow_3.png [new file with mode: 0644]
doc/images/jobmanager_job_workflow_4.png [new file with mode: 0644]
doc/images/jobmanager_job_workflow_5.png [new file with mode: 0644]
doc/images/jobmanager_job_workflow_6.png [new file with mode: 0644]
doc/images/jobmanager_load_save_buttons.png [new file with mode: 0644]
doc/index.rst
doc/job.rst [new file with mode: 0644]
doc/jobmanager_gui.rst [new file with mode: 0644]
doc/resource.rst

index 817e3972c50ddb442ce284724ca0fc315cb7e420..578f572e39429b97625404e0d68566d3df254db9 100644 (file)
@@ -62,7 +62,9 @@ html:
 RSTFILES=          \
 index.rst          \
 intro.rst          \
-resource.rst
+resource.rst       \
+job.rst            \
+jobmanager_gui.rst
 
 
 EXTRA_DIST+= $(RSTFILES) conf.py
diff --git a/doc/images/jobmanager_job_workflow_1.png b/doc/images/jobmanager_job_workflow_1.png
new file mode 100644 (file)
index 0000000..b33e03c
Binary files /dev/null and b/doc/images/jobmanager_job_workflow_1.png differ
diff --git a/doc/images/jobmanager_job_workflow_2.png b/doc/images/jobmanager_job_workflow_2.png
new file mode 100644 (file)
index 0000000..529c2fa
Binary files /dev/null and b/doc/images/jobmanager_job_workflow_2.png differ
diff --git a/doc/images/jobmanager_job_workflow_3.png b/doc/images/jobmanager_job_workflow_3.png
new file mode 100644 (file)
index 0000000..7b25398
Binary files /dev/null and b/doc/images/jobmanager_job_workflow_3.png differ
diff --git a/doc/images/jobmanager_job_workflow_4.png b/doc/images/jobmanager_job_workflow_4.png
new file mode 100644 (file)
index 0000000..6e2e147
Binary files /dev/null and b/doc/images/jobmanager_job_workflow_4.png differ
diff --git a/doc/images/jobmanager_job_workflow_5.png b/doc/images/jobmanager_job_workflow_5.png
new file mode 100644 (file)
index 0000000..bac2e87
Binary files /dev/null and b/doc/images/jobmanager_job_workflow_5.png differ
diff --git a/doc/images/jobmanager_job_workflow_6.png b/doc/images/jobmanager_job_workflow_6.png
new file mode 100644 (file)
index 0000000..b013fe7
Binary files /dev/null and b/doc/images/jobmanager_job_workflow_6.png differ
diff --git a/doc/images/jobmanager_load_save_buttons.png b/doc/images/jobmanager_load_save_buttons.png
new file mode 100644 (file)
index 0000000..a08924f
Binary files /dev/null and b/doc/images/jobmanager_load_save_buttons.png differ
index 58fd3178c450d3897ae1ada5b5671b5fc2bc7372..8d26bfa123519e27e1dd1184008bf7076df70acd 100644 (file)
@@ -12,6 +12,8 @@ Welcome to JOBMANAGER's module documentation!
    :maxdepth: 2
 
    intro
+   job
+   jobmanager_gui
    resource
 
 * :ref:`search`
diff --git a/doc/job.rst b/doc/job.rst
new file mode 100644 (file)
index 0000000..0b45693
--- /dev/null
@@ -0,0 +1,17 @@
+Main JOBMANAGER concept: Job
+============================
+
+What is a job ?
++++++++++++++++
+
+Description of the different types of job
++++++++++++++++++++++++++++++++++++++++++
+
+Command job
+-----------
+
+SALOME script job
+-----------------
+
+YACS job
+--------
diff --git a/doc/jobmanager_gui.rst b/doc/jobmanager_gui.rst
new file mode 100644 (file)
index 0000000..6e91bab
--- /dev/null
@@ -0,0 +1,97 @@
+Using the JOBMANAGER GUI
+========================
+
+Managing a job with the GUI
+---------------------------
+
+Job creation workflow
+---------------------
+
+This section describes the workflow when a job is created. The jobmanager uses a wizard to create a job.
+
+The first page (see :ref:`figure_jobmanager_job_workflow_1`) of the wizard is to define the **job name** 
+and the **job type**. For each job type, the page provides an explanation of what job type refers.
+
+.. _figure_jobmanager_job_workflow_1:
+
+.. figure:: images/jobmanager_job_workflow_1.png
+  :align: center
+
+  **Page 1**
+
+The second page (see :ref:`figure_jobmanager_job_workflow_2`) permits to add two files, the main job file 
+(in this example a command file). You could also add an environment file, it is not mandatory.
+
+.. _figure_jobmanager_job_workflow_2:
+
+.. figure:: images/jobmanager_job_workflow_2.png
+  :align: center
+
+  **Page 2**
+
+The third page (see :ref:`figure_jobmanager_job_workflow_3`) permits to define the batch parameters related
+to your job. You have to define the *Remote work directory*. It's the directory where the job will be executed.
+Input files defined in page 4 will be copied in this directory. You have define how many times the job will be running,
+the amount of memory needed and the number of processors/cores the job need.
+
+.. _figure_jobmanager_job_workflow_3:
+
+.. figure:: images/jobmanager_job_workflow_3.png
+  :align: center
+
+  **Page 3**
+
+The fourth page (see :ref:`figure_jobmanager_job_workflow_4`) permits to add the input and output files. 
+Input files are files located into the user
+computer that have to be transfered into the execution resource. In this page, you also the result 
+directory where job results and logs will be copied.
+
+.. _figure_jobmanager_job_workflow_4:
+
+.. figure:: images/jobmanager_job_workflow_4.png
+  :align: center
+
+  **Page 4**
+
+The fith page (see :ref:`figure_jobmanager_job_workflow_5`) permits to choose the resource in which the job 
+will executed. You can also define the batch queue that you want to use.
+
+.. _figure_jobmanager_job_workflow_5:
+
+.. figure:: images/jobmanager_job_workflow_5.png
+  :align: center
+
+  **Page 5**
+
+The last page (see :ref:`figure_jobmanager_job_workflow_6`) finalize the job creation. You could choose 
+if you want or not start the job at the end of the wizard.
+
+.. _figure_jobmanager_job_workflow_6:
+
+.. figure:: images/jobmanager_job_workflow_6.png
+  :align: center
+
+  **Page 6**
+
+Loading and saving job list
+---------------------------
+
+The JOBMANAGER permits to save and load a list of jobs.
+For some jobs, this feature permits to follow the execution of a job
+into different SALOME session.
+
+The figure :ref:`figure_jobmanager_load_save_buttons` shows where are located 
+the load and save buttons in the JOBMANAGER GUI.
+
+.. _figure_jobmanager_load_save_buttons:
+
+.. figure:: images/jobmanager_load_save_buttons.png
+  :align: center
+
+  **Location of load and save job list**
+
+All jobs cannot be followed between to SALOME session. Indeed, It's the *batch* type
+of the resource that allows to know if you can or not follow a job. Currently, resources
+that use **ssh** for batch configuration cannot be followed. In this case, when the JOBMANAGER
+load the job, it will set this kind job in the **Error** state.
+
index a112ced9513ad5d48e3dc24722bd1731189be185..50ca81b8aca047268fd554f9c23f1e781cee5330 100644 (file)
@@ -117,14 +117,14 @@ shows all the informations of a resource.
 
   **JOBMANAGER resource panel**
 
-Two scenarios with a SALOME resource
-++++++++++++++++++++++++++++++++++++
+Two usage scenarios of SALOME's resource with the JOBMANAGER
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 This section describes to common scenarios for understanding how to describe
 a resource for the JOBMANAGER.
 
-Use an interactive resource
----------------------------
+Using an interactive resource
+-----------------------------
 
 In this scenario, you need to launch a job into your computer or an interactive computer
 available in your network.
@@ -143,8 +143,8 @@ To launch a **SALOME** command job you also need to fill the following attribute
 
 - **applipath**
 
-Use a cluster managed by batch system
--------------------------------------
+Using a cluster managed by batch system
+---------------------------------------
 
 In this scenario, you need to launch a job into a cluster managed by a batch system.