bin/appliskel/README

   1 Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2
   3 Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5
   6 This library is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU Lesser General Public
   8 License as published by the Free Software Foundation; either
   9 version 2.1 of the License.
  10
  11 This library is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public
  17 License along with this library; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20 See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22 =======================================
  23 Set of scripts for a SALOME application
  24 =======================================
  25 *html version of this document is produced with docutils*::
  26
  27   rest2html < doc.txt > doc.html
  28
  29 This document corresponds to SALOME2 3.1. (alpha version)
  30
  31 +-------------------------------------------+
  32 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
  33 +-------------------------------------------+
  34
  35 SALOME Application concept
  36 --------------------------
  37
  38 See SALOME_Application_ to define your own configuration of SALOME and run it
  39 on one or several computers. This is the recommended way of configuration.
  40
  41 .. _SALOME_Application: ../../doc/SALOME_Application.html
  42
  43
  44 User run scripts
  45 ----------------
  46
  47 The SALOME user can use the following scripts:
  48
  49 runAppli
  50    Launches a SALOME Session
  51    (similar to ${KERNEL_ROOT_DIR}/bin/salome/runSalome but with a different
  52    name to avoid confusions).
  53
  54 runSession
  55    Launches a shell script in the SALOME application environment, with access
  56    to the current SALOME session (naming service), if any.
  57    Without arguments, the script is interactive. With arguments, the script
  58    executes the command in the SALOME application environment.
  59
  60 runConsole
  61    Gives a python console connected to the current SALOME Session.
  62    It is also possible to use runSession, then python.
  63
  64 runTests
  65    Similar to runSession, used for unit testing. runTests defines a new
  66    configuration for naming service (new port number) to avoid interferences
  67    with a running SALOME session. runSession tries to use an already existing
  68    naming service definition from a running session (hostname & port number).
  69
  70 killCurrentPort
  71    Kills the last SALOME session corresponding to this application, and
  72    intially launched from this computer.
  73    Cleans associated config files.
  74
  75 SALOME internal run scripts
  76 ---------------------------
  77
  78 envd
  79    Sets SALOME application environment, envd is sourced by other scripts.
  80
  81 getAppliPath.py
  82    Used by other scripts to define the Application Path.
  83
  84 searchFreePort.sh
  85    Used by other scripts to find a free port for naming service.
  86
  87 For remote calls, SALOME uses one script.
  88
  89 runRemote.sh
  90    This script is mainly used to launch containers. The first 2 arguments
  91    define the hostname and port userd for naming service, the remaining
  92    arguments define the command to execute.
  93
  94
  95 The following files must be adapted to your environment and SALOME Application
  96 ------------------------------------------------------------------------------
  97
  98 - CatalogResources.xml
  99 - SalomeApp.xml
 100 - env.d/atFirst.sh
 101 - env.d/envProducts.sh
 102 - env.d/envSalome.sh
 103
 104 CatalogRessources.xml
 105    This files describes all the computer the application can use. The given
 106    example is minimal and suppose ${APPLI} is the same relative path
 107    to ${HOME}, on all the computers. A different directory can be set on a
 108    particular computer with a line::
 109
 110        appliPath="my/specific/path/on/this/computer"
 111
 112 SalomeApp.xml
 113    This file is similar to the default given
 114    in ${GUI_ROOT_DIR}/share/salome/resources/gui
 115
 116
 117 Proposal for env.d scripts
 118 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 119 Each user **must define** his own configuration for these scripts, following
 120 the above rules. **The following is only an example not working as it is**.
 121
 122 atFirst.sh
 123     Sets the computer configuration not directly related to SALOME,
 124     like useful tools, default PATH.
 125
 126 envProducts.sh
 127     Sets the SALOME prerequisites.
 128
 129 envSALOME.sh
 130     Sets all the MODULE_ROOT_DIR that can be used in the SALOME application.
 131
 132     SalomeAppConfig is also defined by::
 133
 134       export SalomeAppConfig=${HOME}/${APPLI}
 135
 136     where SalomeAppConfig designates the directory containing SalomeApp.xml.
 137     Note that ${APPLI} is already defined by the calling scripts when
 138     env.d/envSalome.sh is sourced.