2 \page INSTALL Installation instructions
4 <b>NOT UP TO DATE AND INCOMPLETE DOCUMENT BUT CAN BE HELPFUL</b>
6 You'll find here generic instructions for installing the SALOME platform.
19 \section S1_install Quick Overview
21 First of all, you have to check (or install if needed) the dependant
22 software programs on your system. These programs are:
24 - common development tools as gcc, automake, autoconf and libtools.
25 - third party softwares used in %SALOME building or runtime process
26 (python, OCC, VTK, ...)
28 Further details can be found in sections \ref S2_install and \ref S3_install.
30 If the dependencies are installed on your system, then you have to set
31 your shell environment to get access to the software components
32 (cf. \ref S4_install).
34 The next step is to install the KERNEL (cf. \ref S5_install):
37 $ mkdir <kernel_build>
38 $ mkdir <kernel_install>
42 $ <kernel_src>/configure --prefix=<kernel_install>
47 Then, the %SALOME components GEOM, MED, VISU, ... can be installed
48 with a similar procedure (cf. \ref S6_install).
50 Eventually, the platform can be run by executing the shell script
51 %runSalome (cf. \ref S7_install). Here, somme additionnal variables have to be set
52 to describe the %SALOME runtime configuration (<COMPONENT>_ROOT_DIR,
55 The following provides you with specific instructions for each step.
58 \section S2_install System configuration
60 %SALOME is compiled and tested on differents platforms with native packages:
65 If you have another platform, we suggest the following configuration
69 - automake-1.7 or more (only aclocal is used)
75 - This is the minimum level of automake, autoconf and libtool, if you need
76 to compile all the third party softwares (included OpenCascade 5.2.x).
78 \section S3_install Third-party dependencies
80 The %SALOME platform relies on a set of third-party softwares. The
81 current version depends on the following list
82 (versions given here are from Debian Sarge, except OpenCascade, VTK and MED,
83 which are not Debian packages):
85 - CAS-5.2.4 OpenCascade (try binaries,a source patch is needed)
86 - VTK-4.2.6 VTK 3D-viewer
87 - PyQt-3.13 Python-Qt Wrapper
88 - Python-2.3.5 Python interpreter
89 - SWIG-1.3.24 SWIG library
90 - boost-1_32_0 C++ library (only include templates are used)
91 - hdf5-1.6.2 Files Database library
92 - med-2.2.2 MED Data Format support for file records
93 - omniORB-4.0.5 ORB used in %SALOME
94 - qt-x11-free-3.3.3 Qt library
95 - qwt-4.2 Graph components for Qt
96 - sip4-4.1.1 langage binding software
98 And, in order to build the documentation:
104 Additionnal software may be installed for optional features:
113 - Instructions for installing these software programs can be found in a
114 special note doc/configuration_examples/install-prerequis.
115 - Installation shell scripts are also provided.
116 These scripts have to be adapted to your own configuration.
118 - See doc/configuration_examples/*
120 In the following, we assume that all the third-party softwares are
121 installed in the same root directory, named <salomeroot>/prerequis.
122 Then, your file system should probably look like:
125 <salomeroot>/prerequis/Python-2.2.2
126 <salomeroot>/prerequis/omniORB-3.0.5
127 <salomeroot>/prerequis/qt-x11-free-3.0.5
131 \section S4_install Preparing the shell environment
133 Some variables have to be set to get access to third-party software
134 components (include files, executable, library, ...) during building
137 The shell file prerequis.sh, embedded in the KERNEL source package,
138 provides a template for setting those variables. In this example, all the
139 softwares are supposed to be installed in the same root directory,
140 named here INSTALLROOT.
142 Copy the prerequis.sh in a working directory and adjust the settings
143 to your own configuration. To get the shell prepared, just
144 execute the following command in the building shell:
147 $ source prerequis.sh
150 (we assume here a ksh or bash mode)
153 \section S5_install Installing the KERNEL component
155 We use here the notation <kernel_src> to specify the source directory
156 of the KERNEL component. The shell environment is supposed to have
157 been set (cf. \ref S4_install).
159 Installing the KERNEL from a source package needs three directories:
161 - the source directory, denoted here by <kernel_src>.
163 - the build directory, denoted by <kernel_build> in the following. This
164 directory can't be the same directory as <kernel_src>.
166 - the install directory, denoted by <kernel_install> in the following. This
167 directory can't be the same directory as <kernel_src> or
170 The installing process is:
173 preparing directories
175 create the <kernel_build> and the <kernel_install> directories:
178 $ mkdir <kernel_build>
179 $ mkdir <kernel_install>
183 build configure script
185 go to <kernel_src> directory and generate the "configure" script:
192 If it doesn't work, check your system automake tools as specified in
193 section \ref S2_install.
196 configure the building process
197 go to the build directory and execute the configuration process:
201 $ <kernel_src>/configure --prefix=<kernel_install>
204 Note that <kernel_install> must be an absolute path.
206 When the configure process is complete, check the status of
207 third-party softwares detection. You should have a status like:
210 ---------------------------------------------
212 ---------------------------------------------
234 Default ORB : omniORB
235 ----------------------------------------------
238 If a software get a status "no", then it's not "seen" in the system:
240 - the software is not installed, or
241 - the shell environment is not set correctly.
243 In this example, the software programs graphviz, openpbs and lsf are not
244 installed (optional for most usages).
248 Building the binary files
250 Execute make in the <kernel_build> directory:
257 Installing binary files, scripts and documentation
259 Execute install target in the <kernel_build> directory:
265 \section S6_install Installing the SALOME components
267 Installing a component <COMPONENT> is done by following the same
268 instructions as given for the KERNEL, replacing KERNEL by
269 <COMPONENT> (build_configure, configure, make, make install).
271 You just have to be aware of the dependencies between components:
273 - MED depends on KERNEL
274 - GEOM depends on KERNEL
275 - SMESH depends on KERNEL, MED, GEOM
276 - VISU depends on KERNEL, MED
277 - YACS depends on KERNEL
279 For example, installing the component SMESH needs the previous
280 installation of the KERNEL component, and then the GEOM and MED components.
282 The building process uses the variables <COMPONENT>_ROOT_DIR to
283 localize the dependant components. The variables must be set to the
284 install path directory of the components <COMPONENT> (ex:
285 KERNEL_ROOT_DIR=<kernel_install>).
287 In the above example, the three variables KERNEL_ROOT_DIR,
288 GEOM_ROOT_DIR and MED_ROOT_DIR have to be set before configuring the
289 building process of the SMESH component (STEP 3).
292 \section S7_install Runtime
294 See \ref SALOME_Application to define your own configuration of %SALOME and run it
295 on one or several computers. This is the recommended way of configuration.
297 The following explains the general principles.
299 To run the %SALOME platform, the procedure is:
301 - set the shell environment to get access to third-party softwares:
303 $ source prerequis.sh
306 - define the %SALOME configuration by setting the whole set of
307 variables <COMPONENT>_ROOT_DIR. Here, you just have to set the
308 kernel and the components you need:
310 $ export KERNEL_ROOT_DIR=<kernel_install>
311 $ export MED_ROOT_DIR=<med_install>
315 - define the CORBA configuration file by setting the variable
316 OMNIORB_CONFIG. This variable must be set to a writable file
317 path. The file may be arbitrary chosen and doesn't need to exist
318 before running. We suggest:
320 $ export OMNIORB_CONFIG=$HOME/.omniORB.cfg
323 - run the %SALOME platform by executing the script %runSalome:
325 $KERNEL_ROOT_DIR/bin/salome/runSalome
328 \section S8_install Suggestions and advices
330 For convenience or customization, we suggest the following organisation:
332 - choose and create a root directory for the %SALOME platform, say
335 - install the third-party softwares in a sub-directory "prerequis"
337 - install the %SALOME components in a sub-directory "SALOME2"
339 - make personnal copies of the files prerequis.sh and %runSalome in
342 $ cp <kernel_src>/prerequis.sh <rundir>/.
343 $ cp <kernel_install>/bin/salome/runSalome <rundir>/.
345 Edit the file prerequis.sh and adjust it to your own configuration.
347 - define the SALOME2 configuration\n
348 This step consists in setting the KERNEL_ROOT_DIR, the whole set of
349 variables <COMPONENT>_ROOT_DIR you need, and the OMNIORB_CONFIG
352 We suggest to create a shell file envSalome.sh containing those
353 settings. Then the configuration consists in loading envSalome.sh in
356 $ source envSalome.sh
359 - When installed with this file organisation, running %SALOME is done
360 with the following shell commands:
362 $ source <salomeroot>/prerequis.sh
363 $ source <salomeroot>/envSalome.sh