From: ribes <ribes>
Date: Thu, 23 Sep 2010 14:55:28 +0000 (+0000)
Subject: - Begin of JOBMANAGER documentation
X-Git-Tag: V6_2_0~10
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=79b2ecf4505321766669d1702b0c65af977e8852;p=modules%2Fjobmanager.git

- Begin of JOBMANAGER documentation
---

diff --git a/doc/images/jobmanager_overview.png b/doc/images/jobmanager_overview.png
new file mode 100644
index 0000000..c4aab25
Binary files /dev/null and b/doc/images/jobmanager_overview.png differ
diff --git a/doc/index.rst b/doc/index.rst
index 85bacc6..3aba1db 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -11,5 +11,7 @@ Welcome to JOBMANAGER's module documentation!
 .. toctree::
    :maxdepth: 2
 
+   intro
+
 * :ref:`search`
 
diff --git a/doc/intro.rst b/doc/intro.rst
new file mode 100644
index 0000000..ae07852
--- /dev/null
+++ b/doc/intro.rst
@@ -0,0 +1,29 @@
+Introduction: What is the JOBMANAGER ?
+======================================
+
+The JOBMANAGER module allows creating, launching and following 
+calculation jobs on different types of computers. 
+
+.. figure:: images/jobmanager_overview.png
+  :scale: 75 %
+  :align: center
+
+  **Overview of the JOBMANAGER module**
+
+
+Main functionalities
+++++++++++++++++++++
+
+The JOBMANAGER module permits to define three types of jobs:
+
+- User scripts
+- Python scripts launched in a SALOME session
+- YACS schemas
+
+The module handle different types of computers:
+
+- Interactive computers (rsh, ssh)
+- Clusters managed by batch systems like PBS, LSF or SGE
+
+User's job list could be saved and loaded. Finally, the module provides
+an editor for managing user's SALOME resource (See resource in the KERNEL documentation).