2 =================================================================
3 Installation instructions, up to date for 3.0 version
4 =================================================================
6 You'll find here generic instructions for installing the SALOME2 platform.
8 +-------------------------------------------+
9 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
10 +-------------------------------------------+
17 `2. System configuration`_
19 `3. Third-party dependencies`_
21 `4. Preparing the shell environment`_
23 `5. Installing the KERNEL component`_
25 `6. Installing the SALOME components`_
29 `8. Suggestions and advices`_
35 First of all, you have to check (or install if needed) the dependant
36 software programs on your system. These programs are:
38 - common development tools as gcc, automake, autoconf and libtools.
39 - third party softwares used in SALOME building or runtime process
40 (python, OCC, VTK, ...)
42 Further details can be found in sections [2] and [3].
44 If the dependencies are installed on your system, then you have to set
45 your shell environment to get access to the software components
46 (cf. [4]. "Preparing the shell environment").
48 The next step is to install the KERNEL (cf. [5] "Installing KERNEL"):
52 $ mkdir <kernel_build>
53 $ mkdir <kernel_install>
57 $ <kernel_src>/configure --prefix=<kernel_install>
61 Then, the SALOME components GEOM, MED, VISU, ... can be installed
62 with a similar procedure (cf. [6]).
64 Eventually, the platform can be run by executing the shell script
65 runSalome (cf. [7]). Here, somme additionnal variables have to be set
66 to describe the SALOME runtime configuration (<COMPONENT>_ROOT_DIR,
69 The following provides you with specific instructions for each step.
72 2. System configuration
73 -----------------------
75 SALOME is compiled and tested on differents platforms with native packages:
80 If you have another platform, we suggest the following configuration
84 - automake-1.7 or more (only aclocal is used)
90 - This is the minimum level of automake, autoconf and libtool, if you need
91 to compile all the third party softwares (included OpenCascade 5.2.x).
93 3. Third-party dependencies
94 ---------------------------
96 The SALOME platform relies on a set of third-party softwares. The
97 current version depends on the following list
98 (versions given here are from Debian Sarge, except OpenCascade, VTK and MED,
99 which are not Debian packages):
101 =================== ===================================================
102 CAS-5.2.4 OpenCascade (try binaries,a source patch is needed)
103 VTK-4.2.6 VTK 3D-viewer
104 PyQt-3.13 Python-Qt Wrapper
105 Python-2.3.5 Python interpreter
106 SWIG-1.3.24 SWIG library
107 boost-1_32_0 C++ library (only include templates are used)
108 hdf5-1.6.2 Files Database library
109 med-2.2.2 MED Data Format support for file records
110 omniORB-4.0.5 ORB used in SALOME
111 qt-x11-free-3.3.3 Qt library
112 qwt-4.2 Graph components for Qt
113 sip4-4.1.1 langage binding software
114 =================== ===================================================
116 And, in order to build the documentation:
118 =================== ===================================================
121 =================== ===================================================
124 Additionnal software may be installed for optional features:
126 =================== ===================================================
131 =================== ===================================================
137 - Instructions for installing these software programs can be found in a
138 special note doc/configuration_examples/install-prerequis.
139 - Installation shell scripts are also provided.
140 These scripts have to be adapted to your own configuration.
142 - See doc/configuration_examples/*
144 In the following, we assume that all the third-party softwares are
145 installed in the same root directory, named <salomeroot>/prerequis.
146 Then, your file system should probably look like::
148 <salomeroot>/prerequis/Python-2.2.2
149 <salomeroot>/prerequis/omniORB-3.0.5
150 <salomeroot>/prerequis/qt-x11-free-3.0.5
154 4. Preparing the shell environment
155 ----------------------------------
157 Some variables have to be set to get acces to third-party software
158 components (include files, executable, library, ...) during building
161 The shell file prerequis.sh, embedded in the KERNEL source package,
162 provides a template for setting those variables. In this example, all the
163 softwares are supposed to be installed in the same root directory,
164 named here INSTALLROOT.
166 Copy the prerequis.sh in a working directory and adjust the settings
167 to your own configuration. To get the shell prepared, just
168 execute the following command in the building shell:
170 $ source prerequis.sh
172 (we assume here a ksh or bash mode)
175 5. Installing the KERNEL component
176 ----------------------------------
178 We use here the notation <kernel_src> to specify the source directory
179 of the KERNEL component. The shell environment is supposed to have
182 Installing the KERNEL from a source package needs three directories:
184 - the source directory, denoted here by <kernel_src>.
186 - the build directory, denoted by <kernel_build> in the following. This
187 directory can't be the same directory as <kernel_src>.
189 - the install directory, denoted by <kernel_install> in the following. This
190 directory can't be the same directory as <kernel_src> or
193 The installing process is:
196 preparing directories
198 create the <kernel_build> and the <kernel_install> directories::
200 $ mkdir <kernel_build>
201 $ mkdir <kernel_install>
204 build configure script
206 go to <kernel_src> directory and generate the "configure" script::
211 If it doesn't work, check your system automake tools as specified in
215 configure the building process
216 go to the build directory and execute the configuration process::
219 $ <kernel_src>/configure --prefix=<kernel_install>
221 Note that <kernel_install> must be an absolute path.
223 When the configure process is complete, check the status of
224 third-party softwares detection. You should have a status like::
226 ---------------------------------------------
228 ---------------------------------------------
250 Default ORB : omniORB
251 ----------------------------------------------
253 If a software get a status "no", then it's not "seen" in the system:
255 - the software is not installed, or
256 - the shell environment is not set correctly.
258 In this example, the software programs graphviz, openpbs and lsf are not
259 installed (optional for most usages).
263 Building the binary files
265 Execute make in the <kernel_build> directory::
271 Installing binary files, scripts and documentation
273 Execute install target in the <kernel_build> directory::
278 6. Installing the SALOME components
279 -----------------------------------
281 TInstalling a component <COMPONENT> is done by following the same
282 instructions as given for the KERNEL, replacing KERNEL by
283 <COMPONENT> (build_configure, configure, make, make install).
285 You just have to be aware of the dependencies between components:
287 - MED depends on KERNEL
288 - GEOM depends on KERNEL
289 - SMESH depends on KERNEL, MED, GEOM
290 - VISU depends on KERNEL, MED
291 - SUPERV depends on KERNEL
293 For example, installing the component SMESH needs the previous
294 installation of the KERNEL component, and then the GEOM and MED components.
296 The building process uses the variables <COMPONENT>_ROOT_DIR to
297 localize the dependant components. The variables must be set to the
298 install path directory of the components <COMPONENT> (ex:
299 KERNEL_ROOT_DIR=<kernel_install>).
301 In the above example, the three variables KERNEL_ROOT_DIR,
302 GEOM_ROOT_DIR and MED_ROOT_DIR have to be set before configuring the
303 building process of the SMESH component (STEP 3).
309 See SALOME_Application_ to define your own configuration of SALOME and run it
310 on one or several computers. This is the recommended way of configuration.
312 .. _SALOME_Application: ./SALOME_Application.html
314 The following explains the general principles.
316 To run the SALOME platform, the procedure is:
318 - set the shell environment to get acces to third-party softwares::
320 $ source prerequis.sh
322 - define the SALOME configuration by setting the whole set of
323 variables <COMPONENT>_ROOT_DIR. Here, you just have to set the
324 kernel and the components you need::
326 $ export KERNEL_ROOT_DIR=<kernel_install>
327 $ export MED_ROOT_DIR=<med_install>
330 - define the CORBA configuration file by setting the variable
331 OMNIORB_CONFIG. This variable must be set to a writable file
332 path. The file may be arbitrary chosen and doesn't need to exist
333 before running. We suggest::
335 $ export OMNIORB_CONFIG=$HOME/.omniORB.cfg
337 - run the SALOME platform by executing the script runSalome::
339 $KERNEL_ROOT_DIR/bin/salome/runSalome
342 8. Suggestions and advices
343 --------------------------
345 For convenience or customization, we suggest the following organisation:
347 - chose and create a root directory for the SALOME platform, say
350 - install the third-party softwares in a sub-directory "prerequis"
352 - install the SALOME components in a sub-directory "SALOME2"
354 - make personnal copies of the files prerequis.sh and runSalome in
357 $ cp <kernel_src>/prerequis.sh <rundir>/.
358 $ cp <kernel_install>/bin/salome/runSalome <rundir>/.
360 Edit the file prerequis.sh and adjust it to your own configuration.
362 - define the SALOME2 configuration
364 This step consists in setting the KERNEL_ROOT_DIR, the whole set of
365 variables <COMPONENT>_ROOT_DIR you need, and the OMNIORB_CONFIG
368 We suggest to create a shell file envSalome.sh containing those
369 settings. Then the configuration consists in loading envSalome.sh in
372 $ source envSalome.sh
374 - When installed with this file organisation, running SALOME is done
375 with the following shell commands::
377 $ source <salomeroot>/prerequis.sh
378 $ source <salomeroot>/envSalome.sh