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   <http://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 Also, additional information can be found at SALOME platform web site:
  30
  31   <http://www.salome-platform.org/downloads/license/>
  32
  33 ============
  34 Installation
  35 ============
  36
  37 --------------
  38 Pre-requisites
  39 --------------
  40
  41 SALOME platform relies on a set of third-party softwares; some of them are needed
  42 at build time only, while other ones are needed in runtime also.
  43
  44 For more information about the pre-requisites please visit SALOME platform web
  45 site:
  46
  47 * Check Release Notes and Software Requirements of the latest SALOME release at
  48
  49   <http://www.salome-platform.org/downloads/current-version/>
  50
  51 * Pre-requisites page at SALOME web site:
  52
  53   <http://www.salome-platform.org/downloads/license/>
  54
  55 Note: SALOME JobManager module needs SALOME KERNEL and SALOME GUI as pre-requisites.
  56
  57 ------------------
  58 Basic Installation
  59 ------------------
  60
  61 The build procedure of the SALOME platform is implemented with CMake.
  62 In order to build the module you have to do the following actions:
  63
  64 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  65
  66 2. Create a build directory:
  67
  68    % mkdir JOBMANAGER_BUILD
  69
  70 3. Configure the build procedure:
  71
  72    % cd JOBMANAGER_BUILD
  73    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  74
  75    where
  76    - <mode> is either Release or Debug (default: Release);
  77    - <installation_directory> is a destination folder to install SALOME JobManager
  78       module (default: /usr);
  79    - <path_to_src_dir> is a path to the SALOME JobManager sources directory.
  80
  81    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME JobManager
  82    module will be configured for installation to the /usr directory that requires
  83    root permissions to complete the installation.
  84
  85 4. Build and install:
  86
  87    % make
  88    % make install
  89
  90    This will install SALOME JobManager module to the <installation_directory>
  91    specified to cmake command on the previous step.
  92
  93 -------------------
  94 Custom installation
  95 -------------------
  96
  97 SALOME JobManager module supports a set of advanced configuration options;
  98 for more details learn CMakeLists.txt file in the root source directory.
  99
 100 You can also use other options of cmake command to customize your installation.
 101 Learn more about available options by typing
 102
 103    % cmake --help
 104
 105 =============
 106 Documentation
 107 =============
 108
 109 The directory doc contains additional documentation file of SALOME JobManager module.
 110
 111 ===============
 112 Troubleshooting
 113 ===============
 114
 115 Please, send a mail to webmaster.salome@opencascade.com.