2 # =================================================================
3 # Installation instructions, up to date for 2.2.0 version
4 # =================================================================
7 You'll find here generic instructions for installing the SALOME2 platform.
13 First of all, you have to check (or install if needed) the dependant
14 software programs on your system. These programs are:
16 - common development tools as gcc, automake, autoconf and libtools.
17 - third party softwares used in SALOME building or runtime process
18 (python, OCC, VTK, ...)
20 Further details can be found in sections [2] and [3].
22 If the dependencies are installed on your system, then you have to set
23 your shell environment to get access to the software components
24 (cf. [4]. "Preparing the shell environment").
26 The next step is to install the KERNEL (cf. [5] "Installing KERNEL"):
27 $ mkdir <kernel_build>
28 $ mkdir <kernel_install>
32 $ <kernel_src>/configure --prefix=<kernel_install>
36 Then, the SALOME components GEOM, MED, VISU, ... can be installed
37 with a similar procedure (cf. [6]).
39 Eventually, the platform can be run by executing the shell script
40 runSalome (cf. [7]). Here, somme additionnal variables have to be set
41 to describe the SALOME runtime configuration (<COMPONENT>_ROOT_DIR,
44 The following provides you with specific instructions for each step.
47 2. System configuration
50 We suggest the following configuration for building process:
51 - gcc-3.2 (3.2.3 if gcc3-2 is not the native compiler of your distribution)
52 - automake-1.9 (only aclocal is used)
57 - This is the minimum level of automake,autoconf & libtool, if you need
58 to compile all the third party softwares (included OpenCascade 5.2).
59 - SALOME2 is compiled and tested on a RedHat 8.0 version, with
65 This level of automake,autoconf & libtool is OK if you do not need to
66 recompile OpenCascade 5.2.
68 3. Third-party dependencies
69 ------------------------
71 The SALOME platform relies on a set of third-party softwares. The
72 current version depends on:
74 CAS-5.2 OpenCascade (try binaries,a source patch is needed)
75 PyQt-3.3.2 Python-Qt Wrapper
76 Python-2.2.2 Python interpreter
77 SWIG-1.3.17 SWIG library
78 VTK-4.2.2 VTK 3D-viewer
79 boost-1_31_0 C++ library (only include templates are used)
80 hdf5-1.4.4 Files Database library
81 med-2.1.6 MED Data Format support for file records
82 omniORB-3.0.5 ORB used in SALOME
83 qt-x11-free-3.0.5 Qt library
84 qwt-0.4.1 Graph components for Qt
85 sip-3.3.2 langage binding software
86 tcl8.3 Tcl interpreter
89 And, in order to build the documentation:
94 Additionnal software may be installed for optional features:
96 netgen4.3_calibre3_gcc3.2.3.tgz
97 tix8.1.4_calibre3_gcc3.2.3.tgz
102 ###### To Do -------------------------
104 Instructions for installing these software programs can be found in a
105 special note doc/install-prerequis. Installation shell scripts are
106 also provided. These scripts have to be adapted to your own
108 --> prepare doc/install-prerequis.
109 --> prepare example_prerequis.sh
111 ###### To Do -------------------------
114 In the following, we assume that all the third-party softwares are
115 installed in the same root directory, named <salomeroot>/prerequis.
116 Then, your file system should probably look like:
118 <salomeroot>/prerequis/Python-2.2.2
119 <salomeroot>/prerequis/omniORB-3.0.5
120 <salomeroot>/prerequis/qt-x11-free-3.0.5
124 4. Preparing the shell environment
125 -------------------------------
127 Some variables have to be set to get acces to third-party software
128 components (include files, executable, library, ...) during building
131 The shell file prerequis.sh, embedded in the KERNEL source package,
132 provides a template for setting those variables. In this example, all the
133 softwares are supposed to be installed in the same root directory,
134 named here INSTALLROOT.
136 Copy the prerequis.sh in a working directory and adjust the settings
137 to your own configuration. To get the shell prepared, just
138 execute the following command in the building shell:
140 $ source prerequis.sh
142 (we assume here a ksh or bash mode)
145 5. Installing the KERNEL component
146 -------------------------------
148 We use here the notation <kernel_src> to specify the source directory
149 of the KERNEL component. The shell environment is supposed to have
152 Installing the KERNEL from a source package needs three directories:
154 - the source directory, denoted here by <kernel_src>.
156 - the build directory, denoted by <kernel_build> in the following. This
157 directory can't be the same directory as <kernel_src>.
159 - the install directory, denoted by <kernel_install> in the following. This
160 directory can't be the same directory as <kernel_src> or
163 The installing process is:
165 STEP 1: preparing directories
166 create the <kernel_build> and the <kernel_install> directories.
167 $ mkdir <kernel_build>
168 $ mkdir <kernel_install>
170 STEP 2: build configure script
171 go to <kernel_src> directory and generate the "configure" script.
175 If it doesn't work, check your system automake tools as specified in
178 STEP 3: configure the building process
179 go to the build directory and execute the configuration process:
181 $ <kernel_src>/configure --prefix=<kernel_install>
183 Note that <kernel_install> must be an absolute path.
185 When the configure process is complete, check the status of
186 third-party softwares detection. You should have a status like:
188 ---------------------------------------------
190 ---------------------------------------------
214 Default ORB : omniORB
216 ---------------------------------------------
218 If a software get a status "no", then it's not "seen" in the system:
219 - the software is not installed, or
220 - the shell environment is not set correctly.
222 In this example, the software programs graphviz, openpbs and lsf are not
223 installed (optional for most usages).
226 STEP 4 : Building the binary files
227 Execute make in the <kernel_build> directory:
231 STEP 5: Installing binary files, scripts and documentation
232 Execute install target in the <kernel_build> directory:
236 6. Installing the SALOME components
237 --------------------------------
239 Installing a component <COMPONENT> is done by following the same
240 instructions as given for the KERNEL, replacing KERNEL by
241 <COMPONENT> (build_configure, configure, make, make install).
243 You just have to be aware of the dependencies between components:
245 - MED depends on KERNEL
246 - GEOM depends on KERNEL
247 - SMESH depends on KERNEL, MED, GEOM
248 - VISU depends on KERNEL, MED
249 - SUPERV depends on KERNEL
251 For example, installing the component SMESH needs the previous
252 installation of the KERNEL component, and then the GEOM and MED components.
254 The building process uses the variables <COMPONENT>_ROOT_DIR to
255 localize the dependant components. The variables must be set to the
256 install path directory of the components <COMPONENT> (ex:
257 KERNEL_ROOT_DIR=<kernel_install>).
259 In the above example, the three variables KERNEL_ROOT_DIR,
260 GEOM_ROOT_DIR and MED_ROOT_DIR have to be set before configuring the
261 building process of the SMESH component (STEP 3).
267 To run the SALOME platform, the procedure is:
268 - set the shell environment to get acces to third-party softwares
270 $ source prerequis.sh
272 - define the SALOME configuration by setting the whole set of
273 variables <COMPONENT>_ROOT_DIR. Here, you just have to set the
274 kernel and the components you need.
276 $ export KERNEL_ROOT_DIR=<kernel_install>
277 $ export MED_ROOT_DIR=<med_install>
280 - define the CORBA configuration file by setting the variable
281 OMNIORB_CONFIG. This variable must be set to a writable file
282 path. The file may be arbitrary chosen and doesn't need to exist
283 before running. We suggest:
285 $ export OMNIORB_CONFIG=$HOME/.omniORB.cfg
287 - run the SALOME platform by executing the script runSalome
288 $ $KERNEL_ROOT_DIR/bin/salome/runSalome
291 8. Suggestions and advices
292 ----------------------
294 For convenience or customization, we suggest the following organisation:
296 - chose and create a root directory for the SALOME platform, say
299 - install the third-party softwares in a sub-directory "prerequis"
301 - install the SALOME components in a sub-directory "SALOME2"
303 - make personnal copies of the files prerequis.sh and runSalome in
306 $ cp <kernel_src>/prerequis.sh <rundir>/.
307 $ cp <kernel_install>/bin/salome/runSalome <rundir>/.
309 Edit the file prerequis.sh and adjust it to your own configuration.
311 - define the SALOME2 configuration
312 This step consists in setting the KERNEL_ROOT_DIR, the whole set of
313 variables <COMPONENT>_ROOT_DIR you need, and the OMNIORB_CONFIG
315 We suggest to create a shell file envSalome.sh containing those
316 settings. Then the configuration consists in loading envSalome.sh in
319 $ source envSalome.sh
321 - When installed with this file organisation, running SALOME is done
322 with the following shell commands:
324 $ source <salomeroot>/prerequis.sh
325 $ source <salomeroot>/envSalome.sh
329 # =================================================================