Salome HOME
Merge from V6_main 13/12/2012 BR_KERNEL_REFACTORING V7_1_0_pre
authorvsr <vsr@opencascade.com>
Thu, 13 Dec 2012 12:34:59 +0000 (12:34 +0000)
committervsr <vsr@opencascade.com>
Thu, 13 Dec 2012 12:34:59 +0000 (12:34 +0000)
doc/conf.py.in
doc/images/jobmanager_resource_2.png
doc/jobmanager_gui.rst
doc/resource.rst
src/wrappers/BL_MainWindows_SALOME.cxx

index 053e397ca4ed81ecd2046ee254b2d9e3fd035e60..213873c173fa7e2a514835fba388818e4e0bcc16 100644 (file)
@@ -39,7 +39,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'jobmanager'
-copyright = '2010-2011 CEA/DEN, EDF R&D, A. Ribes'
+copyright = '2010-2012 CEA/DEN, EDF R&D, A. Ribes'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
index 93de34a06cecd1a17a6fac93db7d424c0c878517..58bffc29edefc512a6fb9f8922e76e56cf540776 100644 (file)
Binary files a/doc/images/jobmanager_resource_2.png and b/doc/images/jobmanager_resource_2.png differ
index 986207ee039666f969e7c8749a683429f7786f6a..726949133c51b85636aac8606e56ba413df042b3 100644 (file)
@@ -78,9 +78,23 @@ The second page (see :ref:`figure_jobmanager_job_workflow_2`) permits to add two
 
   **Create wizard page 2**
 
-The third page (see :ref:`figure_jobmanager_job_workflow_3`) permits to define the batch parameters related
+The third page (see :ref:`figure_jobmanager_job_workflow_5`) permits to choose the resource where the job 
+will be 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
+
+  **Create wizard page 3**
+
+The fourth page (see :ref:`figure_jobmanager_job_workflow_3`) permits to define the batch parameters related
 to the job. It's mandatory to define the *Remote work directory* that is the directory where the job will be executed.
-Input files defined in page 4 will be copied in this directory. You also have to define the maximum duration,
+Note that if a work directory is defined for the selected resource, the work directory for the job will be
+created as a subdirectory of the resource work directory by default. The name of this subdirectory will
+contain the current date and time. Of course, you can override this default value.
+Input files defined in page 4 will be copied in this work directory. You also have to define the maximum duration
+(set 0 hours and 0 minutes to use the default value for the queue),
 the amount of memory needed and the number of processors/cores of the job.
 
 .. _figure_jobmanager_job_workflow_3:
@@ -88,9 +102,9 @@ the amount of memory needed and the number of processors/cores of the job.
 .. figure:: images/jobmanager_job_workflow_3.png
   :align: center
 
-  **Create wizard page 3**
+  **Create wizard page 4**
 
-The fourth page (see :ref:`figure_jobmanager_job_workflow_4`) permits to add the input and output files. 
+The fifth 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 transferred into the execution resource. In this page, you could also define the result 
 directory where job's results and logs will be copied.
@@ -100,16 +114,6 @@ directory where job's results and logs will be copied.
 .. figure:: images/jobmanager_job_workflow_4.png
   :align: center
 
-  **Create wizard page 4**
-
-The fifth page (see :ref:`figure_jobmanager_job_workflow_5`) permits to choose the resource where the job 
-will be 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
-
   **Create wizard page 5**
 
 The last page (see :ref:`figure_jobmanager_job_workflow_6`) finalizes the job creation. You could choose 
index d38f0b7a13c3e206bb4aa058cc4403cad453b735..d71876f7da41b2ce3e446442f7d01b7e3d5b969b 100644 (file)
@@ -17,13 +17,31 @@ A resource contains three different kinds of information:
 A resource's name could be different from the computer name since 
 different SALOME installation could coexist in the computer.
 
+Types and usage of SALOME resources
+-----------------------------------
+
+In SALOME, resources can be used in two different ways:
+
+- Resources can be used to launch containers, either semi-automatically with
+  YACS or directly by calling the method GiveContainer of the Container
+  Manager (service provided by the KERNEL).
+- Resources can be used to launch jobs, either with the JOBMANAGER module or
+  with the underlying Launcher service (provided by the KERNEL).
+
+Those two kinds of resources are both managed by the Resource Manager (KERNEL
+service). They can both be created and edited with the resource management
+interface of the JOBMANAGER. This is why some informations describing the
+resources (e.g. CPU clock) are in fact not used at all by the JOBMANAGER to
+launch jobs. If you just want to create a resource to launch jobs, you can
+safely ignore those parameters.
+
 Physical description of the computer
 ------------------------------------
 
 A resource contains a physical description of the computer.
-These informations are used by the resource manager (service provided
-by the KERNEL) to choose and use a resource when a container (in YACS)
-or a job (in JOBMANAGER) has to be launched.
+These informations are used by the Resource Manager to choose and use a
+resource when a container (in YACS) or a job (in JOBMANAGER) has to be
+launched.
 
 The description of each attribute is given in the table below. 
 
@@ -32,21 +50,29 @@ The description of each attribute is given in the table below.
 ========================== ================ =============================================================
 **Attribute**              **Mandatory**    **Description**
 ========================== ================ =============================================================
-**hostname**               Yes              It's the network name of the computer. If the computer is a 
-                                            cluster, you have to give the frontal node name.
+**hostname**               Yes              Network name of the computer. If the computer is a cluster,
+                                            you have to give the head node name.
 **protocol**               Yes              Network protocol to use for creating connections 
                                             (ssh or rsh).
-**username**               Yes              User name to use for creating connections.
-**batch**                  Yes              Type of batch system installed in the resource. Use *ssh* if
+**username**               Yes              User login on the computer.
+**batch**                  Yes              Type of batch manager installed in the resource. Use *ssh* if
                                             the resource is a single computer.
-**iprotocol**              Yes              Internal protocol to use on a cluster (ssh, rsh or srun).
+**iprotocol**              Yes              Internal protocol to use on a cluster (i.e. the command used
+                                            to launch processes on other nodes of the cluster).
 **mpiImpl**                No               MPI implementation to use.
-
-**OS**                     No               It's the operating system name, e.g.: Linux, Windows.
-**nb_node**                No               It's the amount of node of the computer.
-**nb_proc_per_node**       No               It's the amount or processor or core in each node.
-**mem_mb**                 No               It's the amount of memory in megabytes per node.
-**cpu_clock**              No               It's the frequency in gigahertz of the computer's processors.
+**OS**                     No               Operating system name, e.g.: Linux, Windows (not used by
+                                            JOBMANAGER)
+**nb_node**                No               Number of nodes in the computer (not used by JOBMANAGER)
+**nb_proc_per_node**       No               Number of processors or cores in each node (only used with
+                                            PBS batch manager)
+**mem_mb**                 No               Memory per node in megabytes (not used by JOBMANAGER)
+**cpu_clock**              No               Clock rate in gigahertz of the computer's processor(s) (not
+                                            used by JOBMANAGER)
+**Is Cluster Head**        Yes              Indicate if the resource is a cluster managed by a batch
+                                            manager
+**Working Directory**      No               Base working directory for the resource. The working
+                                            directories for the jobs will by default be created as
+                                            subdirectories of this directory.
 ========================== ================ =============================================================
 
 SALOME installation description
@@ -60,10 +86,9 @@ The description of each attribute is given in the table below.
 ========================== =============================================================
 **Attribute**              **Description**
 ========================== =============================================================
-**applipath**              It's the directory of the SALOME application to use into the 
-                           resource.
-**componentList**          It's the SALOME component list available in the SALOME 
-                           application.
+**applipath**              Directory of the SALOME application to use on the resource
+**componentList**          List of the SALOME components available in the SALOME 
+                           application (not used by JOBMANAGER)
 ========================== =============================================================
 
 Where is the resource file?
@@ -135,6 +160,7 @@ To launch a **command** job you need to fill the following attributes:
 - **protocol** = *ssh*
 - **username**
 - **batch** = *ssh*
+- **Is Cluster Head** = *false*
 
 **Warning:** You have to configure ssh for allowing ssh commands without asking 
 interactive password (RSA or DSA keys).
@@ -155,7 +181,8 @@ To launch a **command** job you need to fill the following attributes:
 - **username**
 - **batch**
 - **iprotocol**
-- **nb_proc_per_node**
+- **nb_proc_per_node** (only with PBS batch manager)
+- **Is Cluster Head** = *true*
 
 **Warning:** You have to configure ssh for allowing ssh commands without asking 
 interactive password (RSA or DSA keys) between your computer and the cluster and between
@@ -164,4 +191,3 @@ the cluster's nodes.
 To launch a **SALOME** command job you also need to fill the following attributes:
 
 - **applipath**
-
index a3fc934326a6484025304841419845b2ee453ba0..fe0e9d26b364fe4da5e24c06ccf84d7ca1006d5c 100644 (file)
@@ -18,7 +18,7 @@
 //
 
 #include "BL_MainWindows_SALOME.hxx"
-#include <SalomeApp_Engine_i.hxx>
+#include <SalomeApp_Engine_i.h>
 
 BL::MainWindows_SALOME::MainWindows_SALOME(const QString & module_name) :
   SalomeApp_Module(module_name),