]> SALOME platform Git repositories - tools/install.git/blob - README
Salome HOME
Update README for PAL/SALOME
[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_1.4.1 for the 1.4.1 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_1.4.1/bin/salome for the version 
94           1.4.1) 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/salome.launch ).
101           If this file does not exists, it is created on the first launch of 
102           SALOME from <KERNEL_ROOT_DIR>/bin/salome/salome.launch.
103
104           You can modify SALOME launching options by editing salome.launch file:
105
106           <Configuration-list>
107                <launchoptions>
108                     <gui>yes</gui>
109                     <logger>no</logger>
110                     <xterm>no</xterm>
111                     <portkill>yes</portkill>
112                     <killall>no</killall>
113                </launchoptions>
114                <modules-list>
115                     <module name="...">
116                          <plugin name="..."/>
117                     </module>
118                </modules-list>
119                <containers-list>
120                     <containertype>...</containertype>
121                </containers-list>
122           </Configuration-list>     
123
124           Each parameter described in salome.launch file can be overrided by 
125           using corresponding keys for runSalome script:
126
127           --gui
128                 Launch GUI desktop
129           --logger
130                 Use logger server
131           --xterm
132                 Start each server in its own xterm console window
133           --portkill
134                 Kill SALOME, running on the current port
135           --killall
136                 Kill SALOME, running on all ports
137           --modules=<module>,<module>,...,<module>
138                 Use module, possible values are GEOM, SMESH, VISU, MED, SUPERV
139           --containers=<container>,<container>,...<container>
140                 Start container of type, possible values are cpp,python,superv
141
142           Note that there is no key which corresponds to the <plugin> tag.
143           This tag can be used currently only for SMESH module to point external 
144           meshers plugins which should be loaded by SMESH dynamically.
145           Refer <SMESH_ROOT_DIR>/doc/salome/tui/SMESH/PluginMeshers.html
146           for more information om meshers plugins.
147
148 ================================================================================
149
150   3. Installation notes
151
152      3.1. Time required for the installation
153
154           Installation of all products which are necessary to build and 
155           start SALOME is a time-consuming process and needs from the user to be
156           patient. 
157           The quickest way to install SALOME is installation from the binaries. 
158           In this mode the Installation Wizard just extracts all precompiled 
159           products from the corresponding archives. 
160           The installation from sources requires much more time than from 
161           binaries because in this case the Installation Wizard extracts and 
162           then builds each product using the product's own installation 
163           procedure.
164           The installation time also depends on the computer and platform used.
165           For example, to install SALOME on Pentium III-800, Linux Red Hat 8.0,
166           time of the installation is:
167
168                - from binaries: ~10 minutes;
169                - from sources: up to 7 hours.
170         
171      3.2. Log files
172
173           The Installation Wizard displays the installation progress in the 
174           corresponding windows (see readme.html). The Wizard uses a temporary 
175           directory to store and build the products. During the installation 
176           it produces some log files in this directory. If you suspect that
177           program hangs you can check the log files. These files have names
178           in capital letters like CONFIGURE.LOG, MAKE.LOG or MAKEINSTALL.LOG.
179
180      3.3. Testing of installed SALOME platform
181
182           There is a python script which allows to test shortly all SALOME
183           modules. This script can help to check if SALOME has been installed
184           successfully.
185           To test SALOME platform, run SALOME desktop (see section 2), then 
186           create a new study window (menu command 'File/New') and then type 
187           in the study's python console window:
188  
189                import salome_test
190
191           When running, the script loads diferent modules (Geometry, Mesh, Med, 
192           Post-Pro and Supervisor) and tests different functionality of these 
193           modules. You can watch script running progress in the python console
194           window.
195
196 ================================================================================
197
198   4. How to build SALOME modules from sources
199
200      If you want to build SALOME modules from sources, install all products
201      necessary for the platform and then follow the scenario described below.
202      In the sample scenario it is supposed that you have installed SALOME
203      modules sources in the /home/salome directory. The name of each module's
204      sources directory depends on the version of the platform, for example,
205      KERNEL_SRC_1.4.1 for KERNEL module of PAL/SALOME version 1.4.1.
206
207      According to dependancies between SALOME modules, the order of compilation 
208      and installation is following:
209      
210                - KERNEL
211                      |       _
212                      |_ GEOM  |
213                      |        |- SMESH
214                      |             |_ NETGENPLUGIN (optinal)
215                      |_ MED  _|
216                      |   |
217                      |   |_ VISU
218                      |
219                      |_ SUPERV
220                      |_ COMPONENT
221                      |_ PYCALCULATOR
222
223      - go to KERNEL module's sources directory:
224
225           cd /home/salome/KERNEL_SRC_1.4.1
226
227      - set environment variables (use bash or csh script, depending on 
228        your shell):
229
230           source salome.c[s]h
231
232      - create a configuration script by typing
233
234           ./build_configure
235
236      - go to the parent directory and create build directory:
237
238           cd ..
239           mkdir KERNEL_build
240
241      - configure the sources and create Makefile files:
242
243           cd KERNEL_build
244           ../KERNEL_SRC_1.4.1/configure --prefix=/home/salome/KERNEL_install
245
246      Note, that --prefix option defines the directory where you want to install
247      KERNEL module after make install procedure.
248      More about certain module's configure options you can learn by typing
249      --help (-h) parameter.
250
251      - build and install KERNEL module:
252
253           make
254           make install
255
256        After you have completed this scenario, KERNEL module is built and 
257        installed into /home/salome/KERNEL_install directory.
258
259      - set environment:
260
261         * for bash:
262           export KERNEL_ROOT_DIR=/home/salome/KERNEL_install
263        or 
264           export KERNEL_ROOT_DIR=/home/salome/KERNEL_build
265           (if make install is not done).
266
267         * for csh:
268           setenv KERNEL_ROOT_DIR /home/salome/KERNEL_install
269        or 
270           setenv KERNEL_ROOT_DIR /home/salome/KERNEL_build
271           (if make install is not done).
272
273      - then repeat this scenario for other modules you want to build according
274        to modules dependancies.
275
276 ================================================================================