From: prascle Date: Mon, 21 Nov 2005 09:49:30 +0000 (+0000) Subject: PR: doc correction X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=168b2b90e3b063a55d110a028fd44a2441543b26;p=modules%2Fkernel.git PR: doc correction --- diff --git a/bin/appliskel/README b/bin/appliskel/README index 264b879bc..e54cc886b 100644 --- a/bin/appliskel/README +++ b/bin/appliskel/README @@ -1,42 +1,105 @@ +======================================= Set of scripts for a SALOME application ======================================= +*html version of this document is produced with docutils*:: + + rest2html < doc.txt > doc.html + +This document corresponds to SALOME2 3.1. (alpha version) + ++-------------------------------------------+ +| **WORK in PROGRESS, INCOMPLETE DOCUMENT** | ++-------------------------------------------+ + +SALOME Application concept +-------------------------- + +See SALOME_Application_ to define your own configuration of SALOME and run it +on one or several computers. This is the recommended way of configuration. + +.. _SALOME_Application: ./doc/SALOME_Application.html + + +User run scripts +---------------- + +The SALOME user can use 4 scripts: + +runAppli + Launches a SALOME Session + (similar to ${KERNEL_ROOT_DIR}/bin/salome/runSalome but with a different + name to avoid confusions). + +runSession + Launches a shell script in the SALOME application environment, with access + to the current SALOME session (naming service), if any. + Without arguments, the script is interactive. With arguments, the script + executes the command in the SALOME application environment. + +runConsole + Gives a python console connected to the current SALOME Session. + It is also possible to use runSession, then python. + +runTests + Similar to runSession, used for unit testing. runSession tries to use an + already existing naming service definition from a running session (hostname + and port number), runTests defines a new configuration for naming service + (new port number). + +SALOME internal run scripts +--------------------------- + +envd + Sets SALOME application environment, envd is sourced by other scripts. + +For remote calls, SALOME uses one script. + +runRemote.sh + This script is mainly used to launch containers. The first 2 arguments + define the hostname and port userd for naming service, the remaining + arguments define the command to execute. + +The following files must be adapted to your environment and SALOME Application +------------------------------------------------------------------------------ -# - A SALOME application distributed on several computers needs APPLI -# directories on the same path ($APPLI) relative to $HOME directory -# of the user, on each computer. +- CatalogResources.xml +- SalomeApp.xml +- env.d/atFirst.sh +- env.d/envProducts.sh +- env.d/envSalome.sh -user scripts: -------------- +CatalogRessources.xml + This files describes all the computer the application can use. The given + example is minimal and suppose ${APPLI} is the same relative path + to ${HOME}, on all the computers. A different directory can be set on a + particular computer with a line:: -runAppli : SALOME launch (idem runSalome but different name to avoid - confusion with ${KERNEL_ROOT_DIR}/bin/salome/runSalome + appliPath="my/specific/path/on/this/computer" -runConsole : a python console in the current SALOME session environment +SalomeApp.xml + This file is similar to the default given + in ${GUI_ROOT_DIR}/share/salome/resources -runSession : a shell in SALOME environment, either interactive (without args) - or used to run a program (defined by given args) -internal application scripts: ------------------------------ +Proposal for env.d scripts +~~~~~~~~~~~~~~~~~~~~~~~~~~ +Each user **must define** his own configuration for these scripts, following +the above rules. **The following is only an example not working as it is**. -runRemote.sh : called from remote computer, via ssh, rsh... - used for instance to create container +atFirst.sh + Sets the computer configuration not directly related to SALOME, + like useful tools, default PATH. -envd : sets SALOME application environment - sourced by other scripts +envProducts.sh + Sets the SALOME prerequisites. -The following files must be adapted to your environment and SALOME Application: -------------------------------------------------------------------------------- +envSALOME.sh + Sets all the MODULE_ROOT_DIR that can be used in the SALOME application. -SalomeApp.xml - list of modules, options on server launch and resources... -CatalogResources.xml - configuration of machines used in SALOME application - (no need of modules list and path here) + SalomeAppConfig is also defined by:: -env.d directory must contain the necessary files to source, to define -the SALOME Application environment : - ( envd script source these files in alphanumeric order ) + export SalomeAppConfig=${HOME}/${APPLI} -For instance, - atFirst.sh - general presets - envProducts.sh - prerequisite SALOME environment - envSalome.sh - list of MODULE_ROOT_DIR + where SalomeAppConfig designates the directory containing SalomeApp.xml. + Note that ${APPLI} is already defined by the calling scripts when + env.d/envSalome.sh is sourced. diff --git a/doc/SALOME_Application.txt b/doc/SALOME_Application.txt index ef4205242..590bf2c8f 100644 --- a/doc/SALOME_Application.txt +++ b/doc/SALOME_Application.txt @@ -115,7 +115,7 @@ envSALOME.sh where SalomeAppConfig designates the directory containing SalomeApp.xml. Note that ${APPLI} is already defined by the calling scripts when - envSALOME.sh is sourced. + env.d/envSalome.sh is sourced. 2.2 User run scripts ~~~~~~~~~~~~~~~~~~~~ @@ -143,8 +143,11 @@ runTests and port number), runTests defines a new configuration for naming service (new port number). -2.3 SALOME internal run script -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +2.3 SALOME internal run scripts +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +envd + Sets SALOME application environment, envd is sourced by other scripts. For remote calls, SALOME uses one script. @@ -157,7 +160,8 @@ runRemote.sh ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ SalomeApp.xml - This file is similar to the default given in $GUI_ROOT_DIR + This file is similar to the default given + in ${GUI_ROOT_DIR}/share/salome/resources CatalogRessources.xml This files describes all the computer the application can use. The given