From f54eb9fa8e7d2e04e78e3e457b2d3e55d501f8c7 Mon Sep 17 00:00:00 2001 From: vsr Date: Mon, 11 Apr 2016 09:06:13 +0300 Subject: [PATCH] Update documentation on how to run SALOME --- doc/salome/running_salome.dox | 254 +++++++++++++++++++--------------- 1 file changed, 140 insertions(+), 114 deletions(-) mode change 100644 => 100755 doc/salome/running_salome.dox diff --git a/doc/salome/running_salome.dox b/doc/salome/running_salome.dox old mode 100644 new mode 100755 index cf1a9ab70..cd31a7a1f --- a/doc/salome/running_salome.dox +++ b/doc/salome/running_salome.dox @@ -1,114 +1,140 @@ -/*! - -\page running_salome_page Running Salome - -There are two ways to run %SALOME: - -1) Using Salome Application Concept approach. - -For more details see \ref SALOME_Application. - -2) Using \c %runSalome script supplied with %SALOME KERNEL module distribution. - -To launch %SALOME using \c %runSalome script, you have first to -set-up proper environment for %SALOME. If you installed %SALOME using -%SALOME Installation Wizard (Linux), you can use \c salome.sh or -\c salome.csh script (that is located in the \c KERNEL_<version> -directory of your %SALOME installation), for example: - -\code -cd /home/user/salome_6.5.0/KERNEL_6.5.0 -source salome.csh -\endcode - -Launch %SALOME session using the \c %runSalome script located -in the \c SALOME/KERNEL/bin/salome directory: - -\code -runSalome [options] [STUDY_FILE] [PYTHON_FILE [PYTHON_FILE ...]] -\endcode - -Optionally, you can specify in the command line: -- Study (document) file to be opened in %SALOME session passing; -- One or more Python scripts to be executed after %SALOME - start-up. Python scripts will be executed in the new or opened study - in the order they appear in the command line. - -The \c %runSalome script supports large set of options that allow -specifying the way to launch %SALOME session. Complete description of -all options can be obtained using \c --help or -h option: - -\code -runSalome --help -\endcode - -Here below is a description of most important options: - -- \c --help or \c -h - -Print detail help information on the \c %runSalome script. - -- \c --version - -Print version of %SALOME platform. - -- \c --gui or \c -g - -Launch %SALOME sesssion in GUI mode (with GUI desktop). - -- \c --terminal or \c -t - -Launch %SALOME session in terminal mode (without GUI). - -- \c --resources=<file> or \c -r \c <file> - -Parse application settings from the <file> instead of default resource -file. Default resource file is situated in user's home directory; for -example, for %SALOME version 6.5.0, the file is ${HOME}/.config/salome/.SalomeApprc.6.5.0 - -- \c --modules=module1,module2,... or \c -m=module1,module2,... - -Specify the list of modules which will be used in the %SALOME session -being launched. Note, that list of modules is separated be comma -symbols, with no any spaces. - -- \c --xterm or \c -x - -The servers open in separate terminal window and log messages are displayed in this window. - -- --embedded=registry,study,moduleCatalog,cppContainer/ or - -e=registry,study,moduleCatalog,cppContainer - -Run listed %SALOME servers in the GUI embedded mode (default value is -registry,study,moduleCatalog,cppContainer). Note that logger -server cannot be embedded to GUI. Note, that this option implies running %SALOME in GUI mode (\c -g -option); in terminal mode all servers are running in standalone mode. - -- --standalone=registry,study,moduleCatalog,cppContainerr or - -s=registry,study,moduleCatalog,cppContainer - -Standalone CORBA servers (default: none). - -- \c --portkill or \c -p - -Kill %SALOME session launched with the current port. - -- \c --killall or \c -k - -Kill (stop) all running %SALOME sessions before launching new session. - -- \c --splash=<1/0> or \c -z <1/0> - -Use 1 to display splash screen [default] at start-up, 0 to disable -splash screen. This option is ignored in the terminal mode. - -- \c --pinter - -Launch with interactive Python console. - -- --interp=n or -i=n - -Number of additional Python interpreters to open, with session -environment propely set-up. - -*/ +/*! + +\page running_salome_page Running Salome + +There are three ways to run %SALOME: + +\section S1_run_sal Using the "salome" command + +%A simply %SALOME application is defined by : +- a set of modules (GEOM, SMESH, YACS, ...) +- a profile: set of informatic resources (images, documentation, tests...) binding the modules together +- "salome" command is a launcher as a python script that creates a context (set of environment variables usable by the SALOME modules) and runs an instance of SALOME, for more details see \ref salome_command. + +How to generation of a profile of an application ? + +The user can generate a default profile for its application using the following command: +\code +python ${KERNEL_ROOT_DIR}/bin/salome/app-quickstart.py --prefix= --name= --modules= +\endcode + +Likely, the user would like to personalize its application's profile. Then, the profile +can be compiled using the standard cmake procedure: + +\code +cmake +make +make install +\endcode + +This profile can be used within a python launcher - like the \subpage salome_command - by setting +context variable SalomeAppConfig to the path where the profile is installed. + +\section S2_run_sal Using Salome Application Concept approach + +For more details see \ref SALOME_Application. + +\section S3_run_sal Using "runSalome" script supplied with SALOME KERNEL module distribution + +To launch %SALOME using \c %runSalome script, you have first to +set-up proper environment for %SALOME. If you installed %SALOME using +%SALOME Installation Wizard (Linux), you can use \c salome.sh or +\c salome.csh script (that is located in the \c KERNEL_<version> +directory of your %SALOME installation), for example: + +\code +cd /home/user/salome_6.5.0/KERNEL_6.5.0 +source salome.csh +\endcode + +Launch %SALOME session using the \c %runSalome script located +in the \c SALOME/KERNEL/bin/salome directory: + +\code +runSalome [options] [STUDY_FILE] [PYTHON_FILE [PYTHON_FILE ...]] +\endcode + +Optionally, you can specify in the command line: +- Study (document) file to be opened in %SALOME session passing; +- One or more Python scripts to be executed after %SALOME + start-up. Python scripts will be executed in the new or opened study + in the order they appear in the command line. + +The \c %runSalome script supports large set of options that allow +specifying the way to launch %SALOME session. Complete description of +all options can be obtained using \c --help or -h option: + +\code +runSalome --help +\endcode + +Here below is a description of most important options: + +- \c --help or \c -h + +Print detail help information on the \c %runSalome script. + +- \c --version + +Print version of %SALOME platform. + +- \c --gui or \c -g + +Launch %SALOME sesssion in GUI mode (with GUI desktop). + +- \c --terminal or \c -t + +Launch %SALOME session in terminal mode (without GUI). + +- \c --resources=<file> or \c -r \c <file> + +Parse application settings from the <file> instead of default resource +file. Default resource file is situated in user's home directory; for +example, for %SALOME version 6.5.0, the file is ${HOME}/.config/salome/.SalomeApprc.6.5.0 + +- \c --modules=module1,module2,... or \c -m=module1,module2,... + +Specify the list of modules which will be used in the %SALOME session +being launched. Note, that list of modules is separated be comma +symbols, with no any spaces. + +- \c --xterm or \c -x + +The servers open in separate terminal window and log messages are displayed in this window. + +- --embedded=registry,study,moduleCatalog,cppContainer/ or + -e=registry,study,moduleCatalog,cppContainer + +Run listed %SALOME servers in the GUI embedded mode (default value is +registry,study,moduleCatalog,cppContainer). Note that logger +server cannot be embedded to GUI. Note, that this option implies running %SALOME in GUI mode (\c -g +option); in terminal mode all servers are running in standalone mode. + +- --standalone=registry,study,moduleCatalog,cppContainerr or + -s=registry,study,moduleCatalog,cppContainer + +Standalone CORBA servers (default: none). + +- \c --portkill or \c -p + +Kill %SALOME session launched with the current port. + +- \c --killall or \c -k + +Kill (stop) all running %SALOME sessions before launching new session. + +- \c --splash=<1/0> or \c -z <1/0> + +Use 1 to display splash screen [default] at start-up, 0 to disable +splash screen. This option is ignored in the terminal mode. + +- \c --pinter + +Launch with interactive Python console. + +- --interp=n or -i=n + +Number of additional Python interpreters to open, with session +environment propely set-up. + +*/ -- 2.39.2