1. Running of the Installation Wizard
- You can run the Installation Wizard in two modes: batch and gui.
- It's root directory contains python script runInstall:
-
- [python] runInstall [-g|b] [-f <xml-file>] [-t <taget-dir>] [-tmp <tmp-dir>]
-
- -g
- Runs the Installation Wizard in the GUI mode. In this case
- only <xml-file> key is taken into account.
- This option is used by default.
-
- -b
- Runs the Installation Wizard in the batch mode.
-
- -f <xml-file>
- The configuration file to be used by the Installation Wizard.
- If this parameter is missed then the script tries to define
- the Linux version and uses corresponding xml file.
- For example, for the Mandrake 10.1 config_Mandrake10_1.xml file
- is supposed to be used by default. If the appropriate file
- is not found, config.xml is used by default. This file usually
- refers to the default target platform. For SALOME version 3.0.0
- and higher default target platform is Linux Mandrake 10.1.
-
- -t <target-dir>
- The target directory SALOME products to be installed to.
- If used, overloads target directory, given in the
- configuration xml file (usually /salome).
-
- -tmp <tmp-dir>
- The directory, which is used to contain temporary files.
- If used, overloads temporary directory, given in the
- configuration xml file (usually /tmp).
-
- -h
- Prints help information.
+ The Installation Wizard can be launched in two modes: GUI and batch.
+ The root directory of the Installation Wizard contains Python
+ script runInstall. To run the Installation Wizard just type
+ ./runInstall in the terminal window:
+
+ [ python ] ./runInstall [<options>]
+
+ Without any option this script will launch the SALOME Installation
+ Wizard in the default mode (GUI) with the default installation
+ parameters. The default mode can be overridden by using command
+ line options. Each option has short and long notations:
+
+ -g / --gui
+
+ Runs the Installation Wizard in the GUI mode (this is the default
+ mode).
+
+ -b / --batch
+
+ Runs the Installation Wizard in command-line mode.
+
+ -f FILE / --file=FILE
+
+ Defines the XML configuration file to be used by the Installation Wizard.
+ If the appropriate file is not found, the warning message is shown.
+ If this option is not used then the installation script tries to
+ define the Linux version and use the corresponding XML file.
+ For example, for the Linux Mandriva 2006.0 the config_Mandriva_2006.0.xml
+ file will be used by default.
+
+ -d DIR / --target=DIR
+
+ Defines the target directory for SALOME platform installation.
+ If used, this option overrides the default target directory,
+ indicated in the configuration XML file (usually
+ ${HOME}/salome_<version>).
+
+ -t DIR / --tmp=DIR
+
+ Defines the directory for temporary files. If used, this
+ option overrides the default temporary directory, indicated in
+ the configuration xml file (usually /tmp).
+
+ -a / --all-from-sources
+
+ Forces all products to be installed from sources including SALOME
+ modules. If this option is used all the default installation modes
+ are ignored.
+
+ -s / --single-directory
+
+ Install all SALOME binaries packages to one directory (SALOME_<version>,
+ where <version> is SALOME version).
+ Note: this option is ignored when --all-from-sources (-a) option is used.
+
+ -h / --help
+
+ Prints help information about available options.
+
+ -v / --version
+
+ Prints version information (Note: this is the version number of
+ the Installation Wizard, not of the SALOME platform).
For more detailed information about the Installation Wizard refer to the
readme.html file in the doc directory.
2.1. Setting of the environment for SALOME
Installation Wizard creates some environment files to simplify
- the procedure of launching of SALOME. These shell scripts set all
+ the procedure of launching SALOME. These shell scripts set all
necessary environment variables for all products you have installed.
These files are:
- * salome.csh + salome.sh in the KERNEL module's sources/binaries
- root directories; these files can be used for the launching of
- SALOME.
* env_products.csh + env_products.sh in the target directory;
+ these files can be used for the launching of SALOME.
+ * salome.csh + salome.sh in the KERNEL module's sources/binaries
+ root directories; these files are the copies of the
+ corresponding env_products.* files.
+ * env_build.csh + env_build.sh in the target directory;
these files contain minimal environment settings necessary
to build SALOME packages from sources (see paragraph 4).
source salome.csh
where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g.
- KERNEL_3.0.0 for the 3.0.0 version.
+ KERNEL_4.1.4 for the 4.1.4 version.
2.2. Launching of SALOME
After you set environment you can start SALOME. Go to the KERNEL
- module's binaries directory (KERNEL_3.0.0/bin/salome for the version
- 3.0.0) by using of cd command and then type:
+ module's binaries directory (KERNEL_4.1.4/bin/salome for the version
+ 4.1.4) by using of 'cd' command and then type:
runSalome [<parameters>]
- This will start SALOME according to the configuration parameters which
+ This will start SALOME according to the launching parameters which
are described in the configuration files: SalomeApp.xml in the
- <GUI_ROOT_DIR>/share/salome/resources folder and .SalomeApprc.<version_number>
- file, located in your home directory (where <version_number> is number
- of SALOME version). If the latest file does not exist, it is created during
- the first launch of SALOME.
+ <GUI_ROOT_DIR>/share/salome/resources/gui folder and
+ .SalomeApprc.<version_number> file, located in your home
+ directory (where <version_number> is SALOME version number).
+ If the user configuration file does not exist, it is automatically
+ created when exiting SALOME GUI.
You can modify SALOME launching options by editing your
- ~/.SalomeApprc.<version_number> file:
+ ~/.SalomeApprc.<version_number> file (not all the options are
+ listed below):
<section name="launch">
<parameter name="gui" value="yes"/>
<parameter name="standalone" value="study,pyContainer,cppContainer,registry,moduleCatalog"/>
</section>
- Some parameters described in configuration file can be overrided by
- using of corresponding command-line keys for runSalome script:
-
- --gui
- Launch GUI desktop
- --logger
- Use logger server
- --xterm
- Start each server in its own xterm console window
- --portkill
- Kill SALOME, running on the current port
- --killall
- Kill SALOME, running on all ports
- --modules=<module>,<module>,...,<module>
- Use module(s), possible values are GEOM,SMESH,VISU,MED,SUPERV,etc.
- --embedded=<server>,<server>,...<server>
- Start specified server/container(s) embedded in SALOME Session server
- (i.e. running in the same process), possible values are registry,
- study, moduleCatalog, cppContainer, registry
- --standalone=<server>,<server>,...<server>
- Start standalone server/container(s), possible values are registry,
- study, registry, moduleCatalog, cppContainer, pyContainer, supervContainer.
+ Some parameters described in configuration file can be overridden by
+ using of corresponding command-line options for runSalome script:
+
+ -t, --terminal
+ Launch without GUI (in the terminal mode).
+ -g, --gui
+ Launch in GUI mode [default].
+ -d <1/0>, --show-desktop=<1/0>
+ 1 to activate GUI desktop [default], 0 to not activate
+ GUI desktop (Session_Server starts, but GUI is not
+ shown). Ignored in the terminal mode.
+ -o, --hide-desktop
+ Do not activate GUI desktop (Session_Server starts,
+ but GUI is not shown). The same as --show-desktop=0.
+ -b, --batch
+ Launch in Batch Mode. (Without GUI on batch machine)
+ -l, --logger
+ Redirect messages to the CORBA collector.
+ -f <log-file>, --log-file=<log-file>
+ Redirect messages to the <log-file>
+ -u <script1,script2,...>, --execute=<script1,script2,...>
+ Python script(s) to be imported. Python scripts are
+ imported in the order of their appearance. In GUI mode
+ python scripts are imported in the embedded python
+ interpreter of current study, otherwise in an external
+ python interpreter
+ -r <file>, --resources=<file>
+ Parse application settings from the <file> instead of
+ default $(HOME)/.SalomeApprc.$(version)
+ -x, --xterm
+ Launch each SALOME server in own xterm console
+ -m <module1,module2,...>, --modules=<module1,module2,...>
+ SALOME modules list (where <module1>, <module2> are
+ the names of SALOME modules which should be available
+ in the SALOME session)
+ -e <server1,server2,...>, --embedded=<server1,server2,...>
+ CORBA servers to be launched in the Session embedded
+ mode. Valid values for <serverN>: registry, study,
+ moduleCatalog, cppContainer, SalomeAppEngine [by
+ default the value from the configuration files is
+ used]
+ -s <server1,server2,...>, --standalone=<server1,server2,...>
+ CORBA servers to be launched in the standalone mode
+ (as separate processes). Valid values for <serverN>:
+ registry, study, moduleCatalog, cppContainer,
+ pyContainer, supervContainer [by default the value
+ from the configuration files is used]
+ -p, --portkill
+ Kill SALOME with the current port
+ -k, --killall
+ Kill all running SALOME sessions
+ -i <N>, --interp=<N>
+ The number of additional external python interpreters
+ to run. Each additional python interpreter is run in
+ separate xterm session with properly set SALOME
+ environment
+ -z <1/0>, --splash=<1/0>
+ 1 to display splash screen [default], 0 to disable
+ splash screen. This option is ignored in the terminal
+ mode. It is also ignored if --show-desktop=0 option is
+ used.
+ -c <1/0>, --catch-exceptions=<1/0>
+ 1 (yes,true,on,ok) to enable centralized exception
+ handling [default], 0 (no,false,off,cancel) to disable
+ centralized exception handling.
+ --print-port
+ Print free port and exit
+ --nosave-config
+ Do not save current configuration
+ ${HOME}/.omniORB_last.cfg
+ --pinter
+ Launch with interactive python console.
+ --ns-port-log=<ns_port_log_file>
+ Print Naming Service Port into a user file.
+ --gdb-session
+ Launch session with gdb
+ --version
+ Show program's version number and exit
Additional launch settings are given in other sections, which refer to certain
modules. For example, SMESH plugins which should be used in the SALOME launch
patient.
The quickest way to install SALOME is installation from the binaries.
In this mode the Installation Wizard just extracts all precompiled
- products from the corresponding archives (except those products
+ products from the corresponding archives (except for the products
which can be installed only by compiling from sources).
The installation from sources requires much more time than from
binaries because in this case the Installation Wizard extracts and
then builds each product using the product's own compilation
procedure.
The installation time also depends on the computer and platform used.
- For example, to install SALOME on Pentium IV-2GHz, Linux Mandrake 10.1,
+ For example, to install SALOME on Pentium IV-3GHz, Linux Mandriva 2006.0,
time of the installation is:
- - from binaries: ~10 minutes;
- - from sources: up to 7 hours.
-
+ - from binaries: ~15 minutes;
+ - from sources: more than 24 hours.
+
3.2. Log files
The Installation Wizard displays the installation progress in the
corresponding windows (see readme.html). The Wizard uses a temporary
directory to store and build the products. During the installation
it produces some log files in this directory. If you suspect that
- program hangs you can check the log files. These files have names
+ the program hangs you can check the log files. These files have names
in capital letters like CONFIGURE.LOG, MAKE.LOG, MAKEINSTALL.LOG, etc.
3.3. Testing of installed SALOME platform
- There is a python script which allows to test shortly all SALOME
+ There is a python script which allows quickly testing all SALOME
modules. This script can help to check if SALOME has been installed
successfully.
To test SALOME platform, run SALOME desktop (see section 2), then
import salome_test
When running, the script loads different modules (Geometry, Mesh, Med,
- Post-Pro and Supervisor) and tests different functionality of these
- modules. You can watch script running progress in the python console
- window.
+ Post-Pro and Supervisor) and tests various functionalities of these
+ modules. You can watch the script execution progress in the embedded
+ python console window.
+
+ Note: salome_test.py scripts require SALOME samples module
+ (SAMPLES_SRC) to be installed (this module includes a set of sample
+ MED, Python, Supervisor graph, etc files).
+ Environment variable DATA_DIR should point at the SALOME
+ samples module directory.
================================================================================
4. How to build SALOME modules from sources
- This section describes the way how to build SALOME modules manually from
- sources distribution provided with Installation Wizard.
+ This section describes how to build SALOME modules manually
+ from the sources distribution provided with the Installation Wizard.
4.1. General procedure
If you want to build SALOME modules from sources, install all prerequisite
products, required for the platform and SALOME modules sources.
Then follow the scenario described below.
- In the scenario below it is supposed that you have installed SALOME
+ In this scenario it is supposed that you have installed SALOME
modules sources in the /home/salome directory. The name of each module
sources directory depends on the version of the platform, for example,
- KERNEL_SRC_3.0.0 for KERNEL module of SALOME version 3.0.0.
+ KERNEL_SRC_4.1.4 for KERNEL module of SALOME version 4.1.4.
- The order of compilation and installation should be performed according
- to the dependancies between modules:
+ Compilation and installation should be performed according to
+ the dependencies between modules:
Main SALOME modules:
- * KERNEL -> no dependancies
+ * KERNEL -> no dependencies
* GUI -> KERNEL
* GEOM -> KERNEL, GUI
* MED -> KERNEL, GUI
* NETGENPLUGIN -> KERNEL, GUI, SMESH
* GHS3DPLUGIN -> KERNEL, GUI, SMESH
+ * GHS3DPRLPLUGIN -> KERNEL, GUI, SMESH
+ * HexoticPLUGIN -> KERNEL, GUI, SMESH
+ * BLSURFPLUGIN -> KERNEL, GUI, SMESH
Sample modules:
- * COMPONENT -> KERNEL
- * PYCALCULATOR -> KERNEL,
+ * COMPONENT -> KERNEL, MED
+ * PYCALCULATOR -> KERNEL, MED
+ * CALCULATOR -> KERNEL, MED
* HELLO -> KERNEL, GUI
- * PYHELLO -> KERNEL, GUI
+ * PYHELLO -> KERNEL
* LIGHT -> KERNEL, GUI
+ * RANDOMIZER -> KERNEL, GUI
+ * SIERPINSKY -> KERNEL, GUI, VISU, RANDOMIZER
Note: SMESH plugins and sample modules are optional. You may skip
- compiling them if you do not plan to use NETGEN and/or GHS3D mesher
+ compiling them if you do not plan to use NETGEN and/or GHS3D meshing
algorithms and do not want to build samples.
- In general, each module (except KERNEL and GUI, of course) is optional for
- SALOME. If you do not need any module, just do not compile or install
- it. But remember that some modules require other ones to be built first
- (see dependancies table above).
+ In general, each module (except for KERNEL and GUI, of course) is
+ optional for SALOME. If you do not need a certain module, just do not
+ compile or install it. But remember that some modules require others
+ to be built first (see dependencies table above).
To build KERNEL module:
- create a configuration script by typing
- ../KERNEL_SRC_3.3.0/build_configure
+ ../KERNEL_SRC_4.1.4/build_configure
- run configure script which will check the environment and create
Makefile files:
- ../KERNEL_SRC_3.3.0/configure --prefix=/home/salome/KERNEL_install
+ ../KERNEL_SRC_4.1.4/configure --prefix=/home/salome/KERNEL_install
Note, that --prefix option defines the directory where you want to
install KERNEL module after 'make install' procedure. configure script
- accepts also a lot of other parameters (for example, to build the module
+ also accepts a lot of other parameters (for example, to build the module
in the optimized mode use --disable-debug --enable-production keys).
- More about certain module's configure options you can learn by using
- --help (-h) parameter.
+ You can learn more about the configure of any modules by using --help (-h)
+ parameter.
- build and (optionally) install KERNEL module:
(if make install step was not performed).
- then repeat this scenario for other modules you want to build taking
- into account the dependancies between modules (see dependancies table
+ into account the dependencies between modules (see dependencies table
above).
Note: if the compilation fails it may be caused by bad environment.
- In this case you should check that environment script you use
+ In this case you should check if the environment script that you use
(salome.csh or salome.sh) contains the following lines for each module MODULE:
* for bash:
setenv MODULE_ROOT_DIR /home/salome/<MODULE_distribution>
where <MODULE_distribution> is a MODULE_build or MODULE_install (see above).
-
- 4.2. Automatic build procedure: build.csh script
- From version 2.2.0 SALOME Installation Wizard provides the script
+ 4.2. Automatic build procedure: build.csh and build.sh scripts
+
+ SALOME Installation Wizard includes two scripts which can be used
for automatic building of SALOME modules from sources packages:
- build.csh. It is installed into the top-level target directory
- (the same directory where env_products.[c]sh files are generated.
+ build.csh and build.sh. The scripts are installed into the top-level
+ installation directory (the same directory where env_products.[c]sh
+ files are generated).
- To use this script just install SALOME sources packages with
+ The build.csh and buils.sh scripts implement the same functionality
+ and support the same set of options, but for different shells.
+ Use build.csh script for csh and build.sh for bash.
+ The description below refers to both scripts.
+
+ To use the script just install SALOME sources packages with the
Installation Wizard, then cd to the SALOME installation directory
and type:
./build.csh
- and that's all.
-
By default, build.csh only compiles the modules but does not install them,
i.e. does not perform 'make install' step.
- To do this, use -i option or -p <prefix> where <prefix> is target
- directory.
+ To do this, use -i option or -p <prefix> where <prefix> is the
+ directory SALOME modules should be installed to.
If you want to build only some SALOME modules, just pass them as
parameters, e.g.:
./build.csh -i KERNEL MED GEOM
- The script also provides some other options which specify compiling
- and installation parameters. You can learn about options by using
+ The script also provides other options which specify compiling and
+ installation parameters. You can learn about these options by using
-h key:
./build.csh -h
- When you run build.csh at first time it is not necessary to pass
+ When you run build.csh for the first time it is not necessary to pass
-b, -c parameters. The script detects if build procedure has not yet
- been performed and runs build_configure, configure procedures
- in this case automatically.
+ been performed and in this case runs build_configure, configure scripts
+ automatically.
- Note: for avoiding of collisions it is recommended not to install
+ Note: to avoid collisions it is recommended not to install
SALOME binaries packages with Installation Wizard if you plan to build
SALOME modules from sources packages or to edit/comment all rows
in env_products.csh file concerning binaries packages.
Note: use -d option carefully because in this case the script removes
- existing (previously installed) SALOME modules.
+ the existing (previously installed) SALOME modules.
+
+ Note: please, take into your account that 'make install' step is
+ obligatory for the KERNEL module. Build directory of KERNEL
+ can not be indicated as KERNEL_ROOT_DIR. This is an exception
+ for the SALOME modules. So you should use either option -i
+ or -p of build.sch script when building KERNEL module.
+
+ Note: build.(c)sh scripts do not modify the environment files
+ (env_products.csh, etc). You should do it by yourself.
================================================================================
