src/internal_config/README_SRC.template

   1
   2 Sources
   3 =======
   4
   5 This package includes the sources of the application.
   6 They are located in the $ROOT/ARCHIVES directory.
   7
   8 It also includes a version of SAlomeTools (sat), a suite of scripts to manage
   9 operations on your application (get sources, compilation, test, packaging ...).
  10 This version is configured to work with the application of the package.
  11
  12 sat is located in $ROOT and you can read its documentation in
  13 $ROOT/salomeTools/doc or by using:
  14 > $ROOT/sat --help
  15
  16 If you use bash, you can have completion for sat by sourcing $ROOT/salomeTools/complete_sat.sh:
  17 > source $ROOT/salomeTools/complete_sat.sh
  18
  19
  20 a) Preparing the sources of your application
  21 ============================================
  22 Type the following command to get the source and apply the patches:
  23 > $ROOT/sat prepare ¤{application}
  24
  25 The sources are retrieved from tgz archives located in ARCHIVES directory (or from VCS tools
  26 if they were included)
  27
  28
  29 b) Build ¤{application}
  30 =======================
  31 Type the following command to compile and install the products of your application:
  32 > $ROOT/sat -t compile ¤{application}
  33
  34 The -t option displays the compilation logs in the terminal.
  35
  36 IMPORTANT 1:
  37 On CentOS 6.4 platform, the package devtoolset-2 must be installed to enable
  38 an alternative compiler and the compilation command must be preceded by
  39 "scl enable devtoolset-2".
  40
  41 IMPORTANT 2:
  42 This operation may fail if some required linux packages are not installed on your system.
  43 It is also often necessary to install a nvidia driver.
  44 If you fail to compile and your archive contains pre-compiled binaries,
  45 and you actually only need to modify a SALOME module, or add an extra one,
  46 then you may be interested by a limited compilation based on the binaries used as prerequisites.
  47 In this case please refer to the instructions after
  48 (paragraph compilation based on the binaries used as prerequisites).
  49
  50
  51 c) Set environment for libraries inside ¤{application}
  52 ======================================================
  53 Type the following command to produce the environment files:
  54 > $ROOT/sat environ ¤{application}
  55
  56
  57 d) Create a SALOME launcher
  58 ===========================
  59
  60 Create the launcher:
  61 > $ROOT/sat launcher ¤{application}
  62
  63 IMPORTANT :
  64 If your package already contains a binary installation
  65 this command will overwrite this launcher.
  66 In this case, you will still be able to execute the binary version, by using a copy
  67 of its launcher, called bin¤{launcher}
  68
  69
  70 e) How to set the Distene license
  71 =================================
  72
  73 If your application is based on SALOME and use the SMESH module and MeshGems
  74 prerequisite, you may want to set the Distene license.
  75 To do so, edit the salome  launcher file (its located in the $ROOT directory).
  76
  77 Then, find the lines that begin with:
  78
  79     #[MeshGems]
  80     # Here you can define your license parameters for MeshGems
  81
  82 Set the variables corresponding to your licence after these lines.