================================================================================ README PAL/SALOME Installation Wizard ================================================================================ Contents of this file: 1. Running of the Installation Wizard 2. Running of SALOME 2.1. Setting of the environment for SALOME 2.2. Launching of SALOME 3. Installation notes 3.1. Time required for the installation 3.2. Log files 3.3. Testing of the installed SALOME platform 4. How to build SALOME modules from sources ================================================================================ 1. Running of the Installation Wizard You can run the Installation Wizard in two modes: batch and gui. It's root directory contains python script runInstall: [python] runInstall [-g|b] [-f ] [-t ] [-tmp ] -g Runs the Installation Wizard in the GUI mode. In this case only key is taken into account. This option is used by default. -b Runs the Installation Wizard in the batch mode. -f The configuration file to be used by the Installation Wizard. If this parameter is missed then the script tries to define the Red Hat version and uses corresponding xml file. For example, for the Red Hat 8.0 config_RedHat8_0.xml file is supposed to be used by default. If the appropriate file is not found, config.xml is used by default. -t The target directory SALOME products to be installed to. If used, overloads target directory, given in the configuration xml file. -tmp The directory, which is used to contain temporary files. If used, overloads temporary directory, given in the configuration xml file. -h Prints help information. For more detailed information about the Installation Wizard refer to the readme.html file in the doc directory. ================================================================================ 2. Running of SALOME This section describes how to run SALOME platform after its installation with the Installation Wizard. 2.1. Setting of the environment for SALOME Installation Wizard creates some environment files to simplify the procedure of launching of SALOME. These shell scripts set all necessary environment variables for all products you have installed. These files are: * salome.csh + salome.sh in the KERNEL module's sources/binaries root directories; * env_products.csh + env_products.sh in the target directory. To set SALOME environment just type in the terminal window: cd source salome.sh or cd source salome.csh where is KERNEL binaries directory, e.g. KERNEL_2.0.0 for the 2.0.0 version. 2.2. Launching of SALOME After you set environment you can start SALOME. Go to the KERNEL module's binaries directory (KERNEL_2.0.0/bin/salome for the version 2.0.0) by using of cd command and then type: runSalome [] This will start SALOME according to the configuration parameters which are described into salome.launch file, located in your home directory ( $HOME/.salome/salome.launch ). If this file does not exists, it is created on the first launch of SALOME from /bin/salome/salome.launch. You can modify SALOME launching options by editing salome.launch file: yes no no yes no ... Each parameter described in salome.launch file can be overrided by using corresponding keys for runSalome script: --gui Launch GUI desktop --logger Use logger server --xterm Start each server in its own xterm console window --portkill Kill SALOME, running on the current port --killall Kill SALOME, running on all ports --modules=,,..., Use module, possible values are GEOM, SMESH, VISU, MED, SUPERV --containers=,,... Start container of type, possible values are cpp,python,superv Note that there is no key which corresponds to the tag. This tag can be used currently only for SMESH module to point external meshers plugins which should be loaded by SMESH dynamically. Refer /doc/salome/tui/SMESH/PluginMeshers.html for more information om meshers plugins. ================================================================================ 3. Installation notes 3.1. Time required for the installation Installation of all products which are necessary to build and start SALOME is a time-consuming process and needs from the user to be patient. The quickest way to install SALOME is installation from the binaries. In this mode the Installation Wizard just extracts all precompiled products from the corresponding archives. The installation from sources requires much more time than from binaries because in this case the Installation Wizard extracts and then builds each product using the product's own installation procedure. The installation time also depends on the computer and platform used. For example, to install SALOME on Pentium III-800, Linux Red Hat 8.0, time of the installation is: - from binaries: ~10 minutes; - from sources: up to 7 hours. 3.2. Log files The Installation Wizard displays the installation progress in the corresponding windows (see readme.html). The Wizard uses a temporary directory to store and build the products. During the installation it produces some log files in this directory. If you suspect that program hangs you can check the log files. These files have names in capital letters like CONFIGURE.LOG, MAKE.LOG or MAKEINSTALL.LOG. 3.3. Testing of installed SALOME platform There is a python script which allows to test shortly all SALOME modules. This script can help to check if SALOME has been installed successfully. To test SALOME platform, run SALOME desktop (see section 2), then create a new study window (menu command 'File/New') and then type in the study's python console window: import salome_test When running, the script loads diferent modules (Geometry, Mesh, Med, Post-Pro and Supervisor) and tests different functionality of these modules. You can watch script running progress in the python console window. ================================================================================ 4. How to build SALOME modules from sources If you want to build SALOME modules from sources, install all products necessary for the platform and then follow the scenario described below. In the sample scenario it is supposed that you have installed SALOME modules sources in the /home/salome directory. The name of each module's sources directory depends on the version of the platform, for example, KERNEL_SRC_2.0.0 for KERNEL module of PAL/SALOME version 2.0.0. The order of compilation and installation should be performed in accordance with modules dependancies: * GEOM : KERNEL * MED : KERNEL * SMESH : KERNEL, GEOM, MED * VISU : KERNEL, MED * SUPERV : KERNEL * COMPONENT : KERNEL * PYCALCULATOR : KERNEL * NETGENPLUGIN : KERNEL, SMESH Note: NETGENPLUGIN is optional component. You may skip compiling it if you do not plan to use NETGEN mesher algorithm. In general, each module (except KERNEL, of course) is optional for SALOME. If you do not need any module, just do not compile or install it. - go to KERNEL module's sources directory: cd /home/salome/KERNEL_SRC_2.0.0 - set environment variables (use bash or csh script, depending on your shell): source salome.c[s]h - create a configuration script by typing ./build_configure - go to the parent directory and create build directory: cd .. mkdir KERNEL_build - configure the sources and create Makefile files: cd KERNEL_build ../KERNEL_SRC_2.0.0/configure --prefix=/home/salome/KERNEL_install Note, that --prefix option defines the directory where you want to install KERNEL module after make install procedure. More about certain module's configure options you can learn by typing --help (-h) parameter. - build and install KERNEL module: make make install After you have completed this scenario, KERNEL module is built and installed into /home/salome/KERNEL_install directory. - set environment: * for bash: export KERNEL_ROOT_DIR=/home/salome/KERNEL_install or export KERNEL_ROOT_DIR=/home/salome/KERNEL_build (if make install is not done). * for csh: setenv KERNEL_ROOT_DIR /home/salome/KERNEL_install or setenv KERNEL_ROOT_DIR /home/salome/KERNEL_build (if make install is not done). - then repeat this scenario for other modules you want to build according to modules dependancies. Note: if the compilation fails it may be caused by poor environment. In this case you should check that environment script you use (salome.csh or salome.sh) contains the following lines for each module: * for bash: export PATH=${_ROOT_DIR}/bin/salome:${PATH} export LD_LIBRARY_PATH=${_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH} export PYTHONPATH=${_ROOT_DIR}/bin/salome:${PYTHONPATH} export PYTHONPATH=${_ROOT_DIR}/lib/salome:${PYTHONPATH} export PYTHONPATH=${_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH} export PYTHONPATH=${_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH} * for csh: setenv PATH ${_ROOT_DIR}/bin/salome:${PATH} setenv LD_LIBRARY_PATH ${_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH} setenv PYTHONPATH ${_ROOT_DIR}/bin/salome:${PYTHONPATH} setenv PYTHONPATH ${_ROOT_DIR}/lib/salome:${PYTHONPATH} setenv PYTHONPATH ${_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH} setenv PYTHONPATH ${_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH} ================================================================================