]> SALOME platform Git repositories - tools/install.git/blob - README
Salome HOME
Use OpenCASCADE 5.2
[tools/install.git] / README
1 ================================================================================
2                                      README
3                          PAL/SALOME Installation Wizard
4 ================================================================================
5
6   Contents of this file:
7
8   1. Running of the Installation Wizard
9
10   2. Running of SALOME
11      2.1. Setting of the environment for SALOME
12      2.2. Launching of SALOME
13
14   3. Installation notes
15      3.1. Time required for the installation
16      3.2. Log files
17      3.3. Testing of the installed SALOME platform
18
19   4. How to build SALOME modules from sources
20
21 ================================================================================
22
23   1. Running of the Installation Wizard
24
25      You can run the Installation Wizard in two modes: batch and gui. 
26      It's root directory contains python script runInstall:
27
28      [python] runInstall [-g|b] [-f <xml-file>] [-t <taget-dir>] [-tmp <tmp-dir>]
29
30      -g              
31           Runs the Installation Wizard in the GUI mode. In this case 
32           only <xml-file> key is taken into account. 
33           This option is used by default.
34
35      -b              
36           Runs the Installation Wizard in the batch mode.
37
38      -f <xml-file>   
39           The configuration file to be used by the Installation Wizard.  
40           If this parameter is missed then the script tries to define 
41           the Red Hat version and uses corresponding xml file. 
42           For example, for the Red Hat 8.0 config_RedHat8_0.xml file 
43           is supposed to be used by default. If the appropriate file 
44           is not found, config.xml is used by default.
45
46      -t <target-dir> 
47           The target directory SALOME products to be installed to. 
48           If used, overloads target directory, given in the 
49           configuration xml file.
50
51      -tmp <tmp-dir>  
52           The directory, which is used to contain temporary files.  
53           If used, overloads temporary directory, given in the 
54           configuration xml file.
55
56      -h   
57           Prints help information.
58
59      For more detailed information about the Installation Wizard refer to the 
60      readme.html file in the doc directory.
61
62 ================================================================================
63
64   2. Running of SALOME
65
66      This section describes how to run SALOME platform after its installation 
67      with the Installation Wizard.
68
69      2.1. Setting of the environment for SALOME
70
71           Installation Wizard creates some environment files to simplify 
72           the procedure of launching of SALOME. These shell scripts set all 
73           necessary environment variables for all products you have installed. 
74           These files are: 
75                * salome.csh + salome.sh in the KERNEL module's sources/binaries
76                  root directories;
77                * env_products.csh + env_products.sh in the target directory.
78
79           To set SALOME environment just type in the terminal window:
80
81                cd <KERNEL_ROOT_DIR>
82                source salome.sh
83           or
84                cd <KERNEL_ROOT_DIR>
85                source salome.csh
86
87           where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g. 
88           KERNEL_2.1.0 for the 2.1.0 version.
89
90      2.2. Launching of SALOME
91         
92           After you set environment you can start SALOME. Go to the KERNEL 
93           module's binaries directory (KERNEL_2.1.0/bin/salome for the version 
94           2.1.0) by using of cd command and then type:
95
96                runSalome [<parameters>]
97
98           This will start SALOME according to the configuration parameters which
99           are described into salome.launch file, located in your home directory
100           ( $HOME/.salome_<version-number>/salome.launch ),
101           where <version_number> is number of PAL/SALOME version.
102
103           If this file does not exists, it is created on the first launch of 
104           SALOME from <KERNEL_ROOT_DIR>/bin/salome/salome.launch.
105
106           You can modify SALOME launching options by editing 
107           salome_<version_number>.launch file:
108
109           <Configuration-list>
110                <launchoptions>
111                     <gui>yes</gui>
112                     <logger>no</logger>
113                     <xterm>no</xterm>
114                     <portkill>yes</portkill>
115                     <killall>no</killall>
116                </launchoptions>
117                <modules-list>
118                     <module name="...">
119                          <plugin name="..."/>
120                     </module>
121                </modules-list>
122                <embedded-list>
123                     <embeddedserver>...</embeddedserver>
124                </embedded-list>
125                <standalone-list>
126                     <standaloneserver>...</standaloneserver>
127                </standalone-list>
128           </Configuration-list>     
129
130           Each parameter described in salome.launch file can be overrided by 
131           using corresponding keys for runSalome script:
132
133           --gui
134                 Launch GUI desktop
135           --logger
136                 Use logger server
137           --xterm
138                 Start each server in its own xterm console window
139           --portkill
140                 Kill SALOME, running on the current port
141           --killall
142                 Kill SALOME, running on all ports
143           --modules=<module>,<module>,...,<module>
144                 Use module(s), possible values are GEOM, SMESH, VISU, MED, SUPERV
145           --embedded=<container>,<container>,...<container>
146                 Start specified container(s) embedded in SALOME Session server 
147                 (i.e. running in the same process), possible values are registry, study, 
148                 moduleCatalog, cppContainer, pyContainer, supervContainer
149           --standalone=<container>,<container>,...<container>
150                 Start standalone container(s), possible values are registry, study, 
151                 moduleCatalog, cppContainer, pyContainer, supervContainer
152
153           Note that there is no key which corresponds to the <plugin> tag.
154           This tag can be used currently only for SMESH module to point external 
155           meshers plugins which should be loaded by SMESH dynamically.
156           Refer <SMESH_ROOT_DIR>/doc/salome/tui/SMESH/PluginMeshers.html
157           for more information om meshers plugins.
158
159 ================================================================================
160
161   3. Installation notes
162
163      3.1. Time required for the installation
164
165           Installation of all products which are necessary to build and 
166           start SALOME is a time-consuming process and needs from the user to be
167           patient. 
168           The quickest way to install SALOME is installation from the binaries. 
169           In this mode the Installation Wizard just extracts all precompiled 
170           products from the corresponding archives. 
171           The installation from sources requires much more time than from 
172           binaries because in this case the Installation Wizard extracts and 
173           then builds each product using the product's own installation 
174           procedure.
175           The installation time also depends on the computer and platform used.
176           For example, to install SALOME on Pentium III-800, Linux Red Hat 8.0,
177           time of the installation is:
178
179                - from binaries: ~10 minutes;
180                - from sources: up to 7 hours.
181         
182      3.2. Log files
183
184           The Installation Wizard displays the installation progress in the 
185           corresponding windows (see readme.html). The Wizard uses a temporary 
186           directory to store and build the products. During the installation 
187           it produces some log files in this directory. If you suspect that
188           program hangs you can check the log files. These files have names
189           in capital letters like CONFIGURE.LOG, MAKE.LOG, MAKEINSTALL.LOG, etc.
190
191      3.3. Testing of installed SALOME platform
192
193           There is a python script which allows to test shortly all SALOME
194           modules. This script can help to check if SALOME has been installed
195           successfully.
196           To test SALOME platform, run SALOME desktop (see section 2), then 
197           create a new study window (menu command 'File/New') and then type 
198           in the study's python console window:
199  
200                import salome_test
201
202           When running, the script loads diferent modules (Geometry, Mesh, Med, 
203           Post-Pro and Supervisor) and tests different functionality of these 
204           modules. You can watch script running progress in the python console
205           window.
206
207 ================================================================================
208
209   4. How to build SALOME modules from sources
210
211      If you want to build SALOME modules from sources, install all products
212      necessary for the platform and then follow the scenario described below.
213      In the sample scenario it is supposed that you have installed SALOME
214      modules sources in the /home/salome directory. The name of each module's
215      sources directory depends on the version of the platform, for example,
216      KERNEL_SRC_2.1.0 for KERNEL module of PAL/SALOME version 2.1.0.
217
218      The order of compilation and installation should be performed in accordance
219      with modules dependancies:
220      
221           * KERNEL -> no dependancies
222           * GEOM -> KERNEL
223           * MED -> KERNEL
224           * SMESH -> KERNEL, GEOM, MED
225           * VISU -> KERNEL, MED
226           * SUPERV -> KERNEL
227           * COMPONENT -> KERNEL
228           * PYCALCULATOR -> KERNEL
229           * NETGENPLUGIN -> KERNEL, SMESH
230           * GHS3DPLUGIN -> KERNEL, SMESH
231
232      Note: NETGENPLUGIN, GHS3DPLUGIN are optional components. You may skip compiling them if
233      you do not plan to use NETGEN and/or GHS3D  mesher algorithms.
234      In general, each module (except KERNEL, of course) is optional for SALOME.
235      If you do not need any module, just do not compile or install it.
236
237      - go to KERNEL module's sources directory:
238
239           cd /home/salome/KERNEL_SRC_2.1.0
240
241      - set environment variables (use bash or csh script, depending on 
242        your shell):
243
244           source salome.c[s]h
245
246      - create a configuration script by typing
247
248           ./build_configure
249
250      - go to the parent directory and create build directory:
251
252           cd ..
253           mkdir KERNEL_build
254
255      - configure the sources and create Makefile files:
256
257           cd KERNEL_build
258           ../KERNEL_SRC_2.1.0/configure --prefix=/home/salome/KERNEL_install
259
260      Note, that --prefix option defines the directory where you want to install
261      KERNEL module after make install procedure.
262      More about certain module's configure options you can learn by typing
263      --help (-h) parameter.
264
265      - build and install KERNEL module:
266
267           make
268           make install
269
270        After you have completed this scenario, KERNEL module is built and 
271        installed into /home/salome/KERNEL_install directory.
272
273      - set environment:
274
275         * for bash:
276           export KERNEL_ROOT_DIR=/home/salome/KERNEL_install
277        or 
278           export KERNEL_ROOT_DIR=/home/salome/KERNEL_build
279           (if make install step was not performed).
280
281         * for csh:
282           setenv KERNEL_ROOT_DIR /home/salome/KERNEL_install
283        or 
284           setenv KERNEL_ROOT_DIR /home/salome/KERNEL_build
285           (if make install step was not performed).
286
287      - then repeat this scenario for other modules you want to build in accordance
288        with modules dependancies.
289
290      Note: if the compilation fails it may be caused by poor environment. 
291      In this case you should check that environment script you use (salome.csh
292      or salome.sh) contains the following lines for each module:
293
294         * for bash:
295           export PATH=${<module>_ROOT_DIR}/bin/salome:${PATH}
296           export LD_LIBRARY_PATH=${<module>_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH}
297           export PYTHONPATH=${<module>_ROOT_DIR}/bin/salome:${PYTHONPATH}
298           export PYTHONPATH=${<module>_ROOT_DIR}/lib/salome:${PYTHONPATH}
299           export PYTHONPATH=${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH}
300           export PYTHONPATH=${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH}
301
302         * for csh:
303           setenv PATH ${<module>_ROOT_DIR}/bin/salome:${PATH}
304           setenv LD_LIBRARY_PATH ${<module>_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH}
305           setenv PYTHONPATH ${<module>_ROOT_DIR}/bin/salome:${PYTHONPATH}
306           setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/salome:${PYTHONPATH}
307           setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH}
308           setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH}
309      
310 ================================================================================