1 ================================================================================
3 SALOME Installation Wizard
4 ================================================================================
8 1. Running of the Installation Wizard
11 2.1. Setting of the environment for SALOME
12 2.2. Launching of SALOME
15 3.1. Time required for the installation
17 3.3. Testing of the installed SALOME platform
19 4. How to build SALOME modules from sources
20 4.1. General procedure
21 4.2. Automatic build procedure: build.csh script
23 ================================================================================
25 1. Running of the Installation Wizard
27 The Installation Wizard can be launched in two modes: GUI and batch.
28 The root directory of the Installation Wizard contains Python
29 script runInstall. To run the Installation Wizard just type
30 runInstall in the terminal window:
32 [ python ] runInstall [<options>]
34 Without opstions this script will launch the SALOME Installation
35 Wizard in the default mode (GUI). The default mode can be
36 overriden by using command line options. Each option has short
41 Runs the Installation Wizard in the GUI mode (this is default
46 Runs the Installation Wizard in command-line mode.
50 The XML configuration file to be used by the Installation Wizard.
51 If this option is not used then the installation script tries to
52 define the Linux version and use the corresponding XML file if it
53 is present. For examle, for the Linux Mandrake 10.1 the
54 config_Mandrake_10.1.xml file will be used by default. If the
55 appropriate file is not found, the file config.xml will be
56 used. This file refers to the basic target platform which is
57 Linux Mandrake 10.1 for SALOME 3.0 and newer. If config.xml file
58 is also not found, the warning message box is shown (in GUI mode)
59 or printed to the console (in batch mode) and the Installation
64 The target directory SALOME platform to be installed to. If used,
65 this option overrides the default target directory, given in the
66 configuration XML file (usually ${HOME}/salome_<version>, see
67 here for more detail).
71 The directory, which is used for temporary files. If used, this
72 option overrides the default temporary directory, given in the
73 configuration xml file (usually /tmp, see here for more detail).
77 Prints help information about available options.
81 Prints version information (Note: this is the Installation
82 Wizard's version number, not of SALOME platform).
84 For more detailed information about the Installation Wizard refer to the
85 readme.html file in the doc directory.
87 ================================================================================
91 This section describes how to run SALOME platform after its installation
92 with the Installation Wizard.
94 2.1. Setting of the environment for SALOME
96 Installation Wizard creates some environment files to simplify
97 the procedure of launching of SALOME. These shell scripts set all
98 necessary environment variables for all products you have installed.
100 * env_products.csh + env_products.sh in the target directory;
101 these files can be used for the launching of SALOME.
102 * salome.csh + salome.sh in the KERNEL module's sources/binaries
103 root directories; these files are the copies of the
104 corresponding env_products.* files.
105 * env_build.csh + env_build.sh in the target directory;
106 these files contain minimal environment settings necessary
107 to build SALOME packages from sources (see paragraph 4).
109 To set SALOME environment just type in the terminal window:
117 where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g.
118 KERNEL_3.2.0 for the 3.2.0 version.
120 2.2. Launching of SALOME
122 After you set environment you can start SALOME. Go to the KERNEL
123 module's binaries directory (KERNEL_3.2.0/bin/salome for the version
124 3.2.0) by using of 'cd' command and then type:
126 runSalome [<parameters>]
128 This will start SALOME according to the launching parameters which
129 are described in the configuration files: SalomeApp.xml in the
130 <GUI_ROOT_DIR>/share/salome/resources folder and .SalomeApprc.<version_number>
131 file, located in your home directory (where <version_number> is number
132 of SALOME version). If the latest file does not exist, it is automatically
133 created during the first launch of SALOME.
135 You can modify SALOME launching options by editing your
136 ~/.SalomeApprc.<version_number> file:
138 <section name="launch">
139 <parameter name="gui" value="yes"/>
140 <parameter name="splash" value="yes"/>
141 <parameter name="file" value="no"/>
142 <parameter name="key" value="no"/>
143 <parameter name="interp" value="no"/>
144 <parameter name="logger" value="no"/>
145 <parameter name="xterm" value="no"/>
146 <parameter name="portkill" value="no"/>
147 <parameter name="killall" value="no"/>
148 <parameter name="modules" value="GEOM,SMESH,VISU,SUPERV,MED,COMPONENT"/>
149 <parameter name="embedded" value="SalomeAppEngine"/>
150 <parameter name="standalone" value="study,pyContainer,cppContainer,registry,moduleCatalog"/>
153 Some parameters described in configuration file can be overrided by
154 using of corresponding command-line options for runSalome script:
161 Start each server in its own xterm console window
163 Kill SALOME, running on the current port
165 Kill SALOME, running on all ports
166 --modules=<module>,<module>,...,<module>
167 Use module(s), possible values are GEOM,SMESH,VISU,MED,SUPERV,etc.
168 --embedded=<server>,<server>,...<server>
169 Start specified server/container(s) embedded in SALOME Session server
170 (i.e. running in the same process), possible values are registry,
171 study, moduleCatalog, cppContainer, registry
172 --standalone=<server>,<server>,...<server>
173 Start standalone server/container(s), possible values are registry,
174 study, registry, moduleCatalog, cppContainer, pyContainer, supervContainer.
176 Additional launch settings are given in other sections, which refer to certain
177 modules. For example, SMESH plugins which should be used in the SALOME launch
178 session can be mentioned in the <SMESH> section, e.g.:
180 <section name="SMESH">
181 <parameter name="name" value="Mesh"/>
182 <parameter name="icon" value="ModuleMesh.png"/>
183 <parameter name="plugins" value="StdMeshers,NETGENPlugin"/>
186 ================================================================================
188 3. Installation notes
190 3.1. Time required for the installation
192 Installation of all products which are necessary to build and
193 start SALOME is a time-consuming process and needs from the user to be
195 The quickest way to install SALOME is installation from the binaries.
196 In this mode the Installation Wizard just extracts all precompiled
197 products from the corresponding archives (except those products
198 which can be installed only by compiling from sources).
199 The installation from sources requires much more time than from
200 binaries because in this case the Installation Wizard extracts and
201 then builds each product using the product's own compilation
203 The installation time also depends on the computer and platform used.
204 For example, to install SALOME on Pentium IV-2GHz, Linux Mandrake 10.1,
205 time of the installation is:
207 - from binaries: ~10 minutes;
208 - from sources: more than 24 hours.
210 Note, the most time-consuming process is compiling of CASCADE libraries from
211 sources - it takes about 90% of time needed for compilation of all products.
215 The Installation Wizard displays the installation progress in the
216 corresponding windows (see readme.html). The Wizard uses a temporary
217 directory to store and build the products. During the installation
218 it produces some log files in this directory. If you suspect that
219 program hangs you can check the log files. These files have names
220 in capital letters like CONFIGURE.LOG, MAKE.LOG, MAKEINSTALL.LOG, etc.
222 3.3. Testing of installed SALOME platform
224 There is a python script which allows to test shortly all SALOME
225 modules. This script can help to check if SALOME has been installed
227 To test SALOME platform, run SALOME desktop (see section 2), then
228 create a new study window (menu command 'File/New') and then type
229 in the study's embedded python console window:
233 When running, the script loads different modules (Geometry, Mesh, Med,
234 Post-Pro and Supervisor) and tests different functionality of these
235 modules. You can watch script running progress in the embedded
236 python console window.
238 ================================================================================
240 4. How to build SALOME modules from sources
242 This section describes the way how to build SALOME modules manually from
243 sources distribution provided with Installation Wizard.
245 4.1. General procedure
247 If you want to build SALOME modules from sources, install all prerequisite
248 products, required for the platform and SALOME modules sources.
249 Then follow the scenario described below.
250 In this scenario it is supposed that you have installed SALOME
251 modules sources in the /home/salome directory. The name of each module
252 sources directory depends on the version of the platform, for example,
253 KERNEL_SRC_3.2.0 for KERNEL module of SALOME version 3.2.0.
255 The order of compilation and installation should be performed according
256 to the dependancies between modules:
260 * KERNEL -> no dependancies
262 * GEOM -> KERNEL, GUI
264 * SMESH -> KERNEL, GUI, GEOM, MED
265 * VISU -> KERNEL, GUI, MED
266 * SUPERV -> KERNEL, GUI
270 * NETGENPLUGIN -> KERNEL, GUI, SMESH
271 * GHS3DPLUGIN -> KERNEL, GUI, SMESH
275 * COMPONENT -> KERNEL, MED
276 * PYCALCULATOR -> KERNEL, MED
277 * CALCULATOR -> KERNEL, MED
278 * HELLO -> KERNEL, GUI
280 * LIGHT -> KERNEL, GUI
282 Note: SMESH plugins and sample modules are optional. You may skip
283 compiling them if you do not plan to use NETGEN and/or GHS3D meshing
284 algorithms and do not want to build samples.
286 In general, each module (except KERNEL and GUI, of course) is optional for
287 SALOME. If you do not need any module, just do not compile or install
288 it. But remember that some modules require other ones to be built first
289 (see dependancies table above).
291 To build KERNEL module:
293 - go to installation root directory (/home/salome in this example):
297 - to set environment variables use bash or csh script, depending on
300 source ../env_products.csh
302 source ../env_products.sh
304 - create build directory for the KERNEL module:
309 - create a configuration script by typing
311 ../KERNEL_SRC_3.2.0/build_configure
313 - run configure script which will check the environment and create
316 ../KERNEL_SRC_3.2.0/configure --prefix=/home/salome/KERNEL_install
318 Note, that --prefix option defines the directory where you want to
319 install KERNEL module after 'make install' procedure. configure script
320 accepts also a lot of other parameters (for example, to build the module
321 in the optimized mode use --disable-debug --enable-production keys).
322 More about certain module's configure options you can learn by using
323 --help (-h) parameter.
325 - build and (optionally) install KERNEL module:
330 After you have completed this scenario, KERNEL module is built and
331 installed into /home/salome/KERNEL_install directory.
333 - modify your environment scripts:
337 export KERNEL_ROOT_DIR=/home/salome/KERNEL_install
339 export KERNEL_ROOT_DIR=/home/salome/KERNEL_build
340 (if make install step was not performed).
344 setenv KERNEL_ROOT_DIR /home/salome/KERNEL_install
346 setenv KERNEL_ROOT_DIR /home/salome/KERNEL_build
347 (if make install step was not performed).
349 - then repeat this scenario for other modules you want to build taking
350 into account the dependancies between modules (see dependancies table
353 Note: if the compilation fails it may be caused by bad environment.
354 In this case you should check that environment script you use
355 (salome.csh or salome.sh) contains the following lines for each module MODULE:
359 export MODULE_ROOT_DIR=/home/salome/<MODULE_distribution>
363 setenv MODULE_ROOT_DIR /home/salome/<MODULE_distribution>
365 where <MODULE_distribution> is a MODULE_build or MODULE_install (see above).
367 4.2. Automatic build procedure: build.csh script
369 From version 2.2.0 SALOME Installation Wizard includes the script
370 for automatic building of SALOME modules from sources packages:
371 build.csh. It is installed into the top-level target directory
372 (the same directory where env_products.[c]sh files are generated.
374 To use this script just install SALOME sources packages with
375 Installation Wizard, then cd to the SALOME installation directory
380 By default, build.csh only compiles the modules but does not install them,
381 i.e. does not perform 'make install' step.
382 To do this, use -i option or -p <prefix> where <prefix> is target
385 If you want to build only some SALOME modules, just pass them as
388 ./build.csh -i KERNEL MED GEOM
390 The script also provides some other options which specify compiling
391 and installation parameters. You can learn about options by using
396 When you run build.csh at first time it is not necessary to pass
397 -b, -c parameters. The script detects if build procedure has not yet
398 been performed and runs build_configure, configure scripts
399 in this case automatically.
401 Note: for avoiding of collisions it is recommended not to install
402 SALOME binaries packages with Installation Wizard if you plan to build
403 SALOME modules from sources packages or to edit/comment all rows
404 in env_products.csh file concerning binaries packages.
406 Note: use -d option carefully because in this case the script removes
407 existing (previously installed) SALOME modules.
409 Note: please, take into account 'make install' step is
410 obligatory for the KERNEL module. Build directory of KERNEL
411 can not be pointed as KERNEL_ROOT_DIR. This is an exception
412 for the SALOME modules. So you should use one of options -i
413 or -p of build.sch script when building KERNEL module.
415 ================================================================================