bin/appliskel/README

   1 Copyright (C) 2007-2014  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, or (at your option) any later version.
  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
  26 This document corresponds to SALOME 6.4.0
  27
  28 SALOME Application concept
  29 --------------------------
  30
  31 See the documentation of KERNEL module for more information on SALOME
  32 Application concept and to learn how to define your own configuration of
  33 SALOME and run it on one or several computers. The recommended way to create
  34 a new application is with the script appli_gen.py that can be found in KERNEL
  35 installation. An application has probably already been generated for you if
  36 you downloaded a binary version of SALOME.
  37
  38 To find all the files described below, please refer to a generated
  39 application as some of them are generated automatically and thus are not
  40 present in this appliskel directory.
  41
  42 User run scripts
  43 ----------------
  44
  45 The SALOME user can use the following scripts:
  46
  47 runAppli [DEPRECATED]
  48    Launches a SALOME Session
  49    (similar to ${KERNEL_ROOT_DIR}/bin/salome/runSalome but with a different
  50    name to avoid confusions).
  51
  52 runSession [DEPRECATED]
  53    Launches a shell script in the SALOME application environment, with access
  54    to the current SALOME session (naming service), if any.
  55    Without arguments, the script is interactive. With arguments, the script
  56    executes the command in the SALOME application environment.
  57
  58 runConsole [DEPRECATED]
  59    Gives a python console connected to the current SALOME Session.
  60    It is also possible to use runSession, then python.
  61
  62 salome [NEW]
  63    A single Python command to start SALOME:
  64    salome [start]:  replace runAppli
  65    salome shell:    replace runSession
  66    salome console:  replace runConsole
  67
  68
  69 SALOME internal run scripts
  70 ---------------------------
  71
  72 envd
  73    Sets SALOME application environment, envd is sourced by other scripts.
  74
  75 getAppliPath.py
  76    Used by other scripts to define the Application Path.
  77
  78 For remote calls, SALOME uses one script.
  79
  80 runRemote.sh
  81    This script is mainly used to launch containers. The first 2 arguments
  82    define the hostname and port userd for naming service, the remaining
  83    arguments define the command to execute.
  84
  85
  86 The following files can be adapted to your environment and SALOME Application
  87 ------------------------------------------------------------------------------
  88
  89 - CatalogResources.xml
  90 - SalomeApp.xml
  91 - env.d/atFirst.sh
  92 - env.d/envProducts.sh
  93 - env.d/envSalome.sh
  94
  95 CatalogResources.xml
  96    This files describes all the computers the application can use. The default
  97    file is minimal. A specific application directory can be set on a
  98    particular computer with a line::
  99
 100        appliPath="my/specific/path/on/this/computer"
 101
 102 SalomeApp.xml
 103    This file is similar to the default given
 104    in ${GUI_ROOT_DIR}/share/salome/resources/gui
 105
 106
 107 Proposal for env.d scripts
 108 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 109 Each user can define his own configuration for these scripts, following
 110 the above rules. The generated files are good examples to start with.
 111
 112 envProducts.sh
 113     Sets the SALOME prerequisites.
 114
 115 configSalome.sh
 116     Sets all the MODULE_ROOT_DIR that can be used in the SALOME application.
 117
 118 configGUI.sh
 119     Sets variables necessary for SALOME GUI.
 120     SalomeAppConfig is defined by::
 121
 122       export SalomeAppConfig=${HOME}/${APPLI}
 123
 124     where SalomeAppConfig designates the directory containing SalomeApp.xml.
 125     Note that ${APPLI} is already defined by the calling scripts when
 126     env.d/configGUI.sh is sourced.