README

   1 ****************
   2 About JobManager
   3 ****************
   4
   5 JobManager module is an interface to use SALOME Launcher services. It allows
   6 defining three types of jobs:
   7 - User scripts;
   8 - Python scripts launched in a SALOME session;
   9 - YACS schemas.
  10
  11 The module handles different types of computational resources:
  12 - Interactive computers (rsh, ssh);
  13 - Clusters managed by batch systems like PBS, LSF or SGE.
  14
  15 User's job list could be saved and loaded. Finally, the module provides
  16 an editor for managing user's SALOME resources.
  17
  18 For more information please visit the SALOME platform web site:
  19
  20   <https://www.salome-platform.org/>
  21
  22 =======
  23 License
  24 =======
  25
  26 SALOME platform is distributed under the GNU Lesser General Public License.
  27 See COPYING file for more details.
  28
  29 ============
  30 Installation
  31 ============
  32
  33 --------------
  34 Pre-requisites
  35 --------------
  36
  37 SALOME platform relies on a set of third-party softwares; some of them are needed
  38 at build time only, while other ones are needed in runtime also.
  39
  40 For more information about the pre-requisites please visit SALOME platform web
  41 site:
  42
  43 * Check Release Notes and Software Requirements of the latest SALOME release at
  44
  45   <https://www.salome-platform.org/?page_id=15/>
  46
  47 Note: SALOME JobManager module needs SALOME KERNEL and SALOME GUI as pre-requisites.
  48
  49 ------------------
  50 Basic Installation
  51 ------------------
  52
  53 The build procedure of the SALOME platform is implemented with CMake.
  54 In order to build the module you have to do the following actions:
  55
  56 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  57
  58 2. Create a build directory:
  59
  60    % mkdir JOBMANAGER_BUILD
  61
  62 3. Configure the build procedure:
  63
  64    % cd JOBMANAGER_BUILD
  65    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  66
  67    where
  68    - <mode> is either Release or Debug (default: Release);
  69    - <installation_directory> is a destination folder to install SALOME JobManager
  70       module (default: /usr);
  71    - <path_to_src_dir> is a path to the SALOME JobManager sources directory.
  72
  73    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME JobManager
  74    module will be configured for installation to the /usr directory that requires
  75    root permissions to complete the installation.
  76
  77 4. Build and install:
  78
  79    % make
  80    % make install
  81
  82    This will install SALOME JobManager module to the <installation_directory>
  83    specified to cmake command on the previous step.
  84
  85 -------------------
  86 Custom installation
  87 -------------------
  88
  89 SALOME JobManager module supports a set of advanced configuration options;
  90 for more details learn CMakeLists.txt file in the root source directory.
  91
  92 You can also use other options of cmake command to customize your installation.
  93 Learn more about available options by typing
  94
  95    % cmake --help
  96
  97 =============
  98 Documentation
  99 =============
 100
 101 The directory doc contains additional documentation file of SALOME JobManager module.
 102
 103 ===============
 104 Troubleshooting
 105 ===============
 106
 107 Please, send a mail to webmaster.salome@opencascade.com.