SALOME 3 Installation Wizard Help

Without opstions this script will launch the SALOME Installation Wizard in the default mode (GUI).
The default mode can be overriden by using command line options. Each -option has two notations: short and long:
+option has short and long notations:

Prints version information (this is the -Installation Wizard's version number, not SALOME platform).
+

Prints version information (Note: this is the +Installation Wizard's version number, not of SALOME platform).

@@ -163,7 +166,8 @@ and Implementing installation scripts for the new products sections for more information.

GUI mode

The Installation Wizard was developed +

The Installation Wizard's GUI wizard +was developed with using of the Trolltech's Qt @@ -188,30 +192,43 @@ button:

Figure 1: "Introduction" page

In the second page you are proposed to enter the target directory -where all selected products should be installed to. You can also press "Browse..." -button and choose the folder for installation using standard browse +where the SALOME platform should be installed to. You can also press "Browse..." +button and choose the destination folder using standard browse directory dialog box.
If the directory you want to install products does not exist you will be prompted to confirm directory creation. If you type wrong directory path, or if you have no permission for the directory you use, the -corresponding message box will raise.

The Installation Wizard in GUI mode provides two different options +corresponding message box will be shown.
+

In GUI mode the Installation Wizard provides two different options to install the SALOME platform: basic -(default) and -advanced. If the basic option is used (default) the -user just need to enter the target installation -directory. To switch to the advanced -option, click "More..." button (see Fig.2 ).

+(which is default) and +advanced. In the basic mode the +user should enter only the target installation +directory. All other installation options are taken from the XML +configuration file (see Fig.2):
+

Figure 2: "Installation settings" +page in the 'basic' mode
+

To switch to the advanced +option, click "More..." button (see Fig.3 +).

In the advanced mode you have the possibility to select products to be installed. Each product can have several options of installation: you have a possibility to use -native products, install already precompiled binaries, build product +native product (provided with Linux distribution and installed in the +system folders), install already precompiled binaries, build product from the sources or not install it at all. Possible options and default -choice are provided by the configuration file. You can mark the +option are taken from the XML configuration file. You can mark the products you want to install by clicking the corresponding -radiobuttons in the list view in the left part of the page. Note that +radiobuttons in the list view in the left part of the page.
+Note, that some products can be installed only together with other products (or these prerequisite products should be already installed on your computer). The installation procedure @@ -221,61 +238,63 @@ For example, in order to install PyQt it's necessary to have gcc, Python, Qt and Sip installed. -Therefore all these products will be marked when you check on PyQt. +Therefore all these products will be also turned on when you check on PyQt. This feature can be switched off by clicking "Auto set prerequisites products" checkbox. Turn on this checkbox if you want all pre-requisite products to be automatically checked when you select some product to be installed. Turn off this checkbox if you want to disable this feature.
+

+
+t

Figure 3: "Installation settings" page in the 'advanced' mode

+ +

If you want to use native products (like gcc, tcl, etc.), select "use native" option.
Special button in the right part of the page - "Unselect All" - allows to reset quickly all products to the "not install" state.
-
-If you want to use native products (like gcc, tcl, etc.), select "use native" option.

There are also two checkboxes on this page: "SALOME sources" and "SALOME binaries". These three-state checkboxes allow quick selecting/unselecting SALOME -itself packages +modules sources/binaries packages for the installation.

The box at the right side of the page displays the information about -currently highlighted product: name, version, short description (if -provided in XML file), required +currently highlighted product: name, version and short description, +required disk space, disk space required for temporary files, list of -prerequisites and current user +prerequisites (this information is +provided in the XML file) and current user choice.

-
-

Figure 2: "Installation settings" page in the advanced mode

- -

The "Total disk space required:" field displays how much +The "Total disk space required:" field displays how much disk space on the hard drive is required for installation of selected products.
-Note: Please, take into account that displayed amount of +

Note: Please, take into account that displayed amount of required disk space is approximate and may differ when you install products on your hard drive.

The installation procedure uses a special directory to store temporary files. The "Space for temporary files:" field shows the information about required disk space on the hard drive for extracting and compiling of the selected products. You can change the -default directory - just type path +temporary directory - just type path to the folder you want to use or click on the corresponding "Browse..." button.
-Note: actually temporary files -are stored not in the directory entered by user. The Installation -Wizard creates in this directory an additional one folder named +Note: actually, temporary files +are stored not directly in the directory entered by user. The +Installation +Wizard creates in this directory an additional folder named something like INSTALLWORKXXXXX where XXXXX is unique number. This allows to launch several Installation Wizards simultaneously. This temporary directory is removed automaticaly when the installation finishes.

The installation procedure also checks available disk space on the -selected directories according to the products selected. If there is no +

The installation procedure also checks available disk space. If +there is no enough disk space on your hard drive you will see the corresponding error message box.

Note: Unfortunately, the configure procedure has a very @@ -290,48 +309,69 @@ spaces.

program will make some tests to check installation settings: if there is enough disk -space on the hard drive, if native products are preinstalled, +space on the hard drive, check for native products installation, dependencies (prerequisites) for each product you have selected to be installed. If any test fails you will see the corresponding warning message box. Otherwise -wizard will follow to the next page:

+the wizard will proceed to the next page:

- Choice page t

Figure 3: "Check your choice" page

Figure 4: "Check your choice" page

This page summarizes the installation settings you've made on the -previous pages. You can check again your choice to change it if -necessary.
+

This page summarizes the installation options you've made on the +previous pages. You can check again your choice and change it if +necessary by getting back to previous page.
When you are sure that everything is OK, press "Next" button to follow to the next page.

Figure 4: "Installation progress" page

- -

To start installation of the selected products click "Start" + Progress page
+

Figure 5: "Installation progress" page

To start installation of the selected +products click "Start" button. It launches the shell installation script and you will be able to see the output of the script in the topmost dialog's frame. If any errors occur during the installation the progress the corresponding messages -will be printed to the log grame window in the bold red font. +will be printed to the log window in the bold red font.
+

It is possible at any time to break the +installation by pressing "Stop" +button. Then you can get back to the previous pages if you wish to +change installation settings or restart installation by pressing again "Start" button.
+

Note: +in the current +implementation it is not possible to resume stopped installation +process; it will be re-started from the very beginning.

Figure 6: "Installation progress" page: installation in +progress
+

The "Installation Status" frame window shows you the -progress of installation. It contains a list of all selected products -with brief descriptions. "Waiting" -description means that installation of this product have not started -yet. Currently installing product is marked as "Processing". +progress of installation. "Waiting" status +means that installation of this product has not been started +yet. The product currently being installed is marked as "Processing". All installed products have "Completed" -description.

+status.

You can abort installation and close the installation procedure using -"Cancel" button. It sends the signal "SIGTERM" to the shell +"Cancel" button.
+Note: this button sends the +signal "SIGTERM" to the shell script. -The script has a signal handler and will try to clear all temporary +The script tries to clear all temporary files. The process of removing temporary files can take some time, so the installation @@ -343,20 +383,40 @@ installation or click "Next" button to go the Readme page:

- Readme page

Figure 5: "Finish installation" page

Figure 7: "Finish installation" page

In this page you can read important information about the Instalation -Wizard itself and some hints: how to run and test SALOME or how to +Wizard itself and some tips: how to run and test SALOME or how to build SALOME from the sources. This is the contents of the README file which you can find in the root directory of the Installation Wizard.
You can also launch SALOME Desktop from this page by clicking "Launch -SALOME" button.

During the process of installation the +SALOME" button.
+

Batch mode
+

+To launch the Installation Wizard in the batch mode type use -b +(--batch) parameter.
+In this mode the GUI wizard is not shown but all the installation +status is displayed directly in the konsole. In the batch mode user do +not have a possibility to change installation settings which are given +in the configuration file, except target and temporary directories +which can be overridden by the corresponding command line options (see here).
+

+
+Figure 8: Batch mode
+

Environment files

During the process of installation the script creates some environment files to simplify procedure of launching SALOME. These shell scripts set @@ -368,437 +428,288 @@ in the KERNEL module sources and KERNEL module binaries root directories and env_products.csh -+ env_products.sh in the target directory.
++ env_products.sh and env_build.csh ++ env_build.sh in the +target directory.

-Note: salome.(c)sh and env_products.(c)sh -files are slightly different: env_products.* files are optimized to +Note: there is some difference +betwen these files: env_build.* +files are optimized to be used for the building of SALOME modules from sources (see README file provided with the -installation procedure on th CD). The salome.* files are optimized for -the SALOME launching. This difference is defined by the environment +installation procedure on th CD). The env_products.* +(and salome.*) files are +optimized for +the SALOME launching. The behavior is defined by the environment variable ENV_FOR_LAUNCH -which is set to 0 in env_products.* files and to 1 in salome.* files.
-

Batch mode
-

-In the batch mode ... bla-bla-bla ...
+which is set to 0 in env_build.* files and to 1 in emv_products.* +(salome.*) files.

Notes on check products version procedure

Unfortunately under Linux platform there is no exact algorithm to -identify the product's version. The table below gives an idea how the -version is checked for the preinstalled products for the Linux Mandrake -10.1 platform.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- Product -	- Algorithm of checking -	- Preliminary steps before launching - - of installation procedure -	- Notes -
gcc 3.4.1	ver=`gcc -dumpversion`	- - -	ver should be 3.4.1. -It is recommended to use native gcc on Mandrake 10.1. -
tcl 8.4.5	1) check if - TCLHOME variable is set - 2) existence of tclsh8.4 - 3) existence of wish8.4 - 4) existence of -libtcl8.4.so - 5) existence of -libtk8.4.so -	set TCLHOME if you -have preinstalled version of tcl. -add a directory where libraries can be found to the LD_LIBRARY_PATH -	Unfortunately there is no more strict way to check the tcl -version number. -It is recommended to use native tcl/tk on Mandrake 10.1.
boost 1.31.0 -	1) check -if BOOSTDIR variable is set. - 2) ver=`egrep 'BOOST_VERSION [0-9]+' -${BOOSTDIR}/boost/version.hpp \| sed 's/.*BOOST_VERSION -$[0-9]\+$/\1/g'` -	set BOOSTDIR -if you have preinstalled version of -boost -	we use version.hpp file in the boost -distribution to get the version information. - ver should be equal to -103100. -
Open CASCADE 6.0 -	1) check if CASROOT variable is set - 2) ver_major=`grep -"!define OCC_VERSION_MAJOR" -${CASROOT}/inc/Standard_Version.hxx \| awk '{print $3}'` - 3) ver_minor=`grep -"!define OCC_VERSION_MINOR" -${CASROOT}/inc/Standard_Version.hxx \| awk '{print $3}'` - 4) ver_maint=`grep -"!define OCC_VERSION_MAINTENANCE" -${CASROOT}/inc/Standard_Version.hxx \| awk '{print $3}'` - 5) ver="$ver_major.$ver_minor.$ver_maint" -	set CASROOT if you -have preinstalled version of Open CASCADE	CASCADE's Standard_Version.hxx file provides version -information. - ver should be equal to -6.0.0. -
Python 2.3.4	1) PYTHONHOME variable should be set - 2) isPython=`which -python` - 3) ver=`python -V`	set PYTHONHOME to -root Python distribution folder; -add the directory where python can be found to the PATH variable -	Python should exist and ver -should be equal to 2.3.4 -It is recommended to use native Python on Mandrake 10.1.
Swig 1.3.24	ver=`swig -version -2>&1 \| grep -i version \| awk '{ print $3 }' \| sed -e -'s/^$[0-9.]$$.$/\1/'`	add the directory where swig binary can be found to the PATH variable	Swig should exist and ver -should be equal to 1.3.24.
Qt 3.3.3	1) QTDIR variable -should be set. - 2) ver=`grep -"QT_VERSION_STR" ${QTDIR}/include/qglobal.h \| sed -e -'s%^#define QT_VERSION_STR$[[:space:]]*$%%g' -e 's%\"%%g'`	set QTDIR if you -have preinstalled version of qt	Qt's qglobal.h file provides version information: ver should -be equal to 3.0.5. -It is recommended to use native Qt on Mandrake 10.1.
msg2qm (Qt 3.3.3 compatible) -	MSG2QM_ROOT -variable should be set. -	set MSG2QM_ROOT if you have preinstalled -version of msg2qm tool -	msg2qm is Qt tool used to +identify the product's version. The information in this section gives +an idea how the +version is checked for the native/preinstalled products (this +information refers to the base platform Linux Mandrake +10.1; and the same algorithms are used for other platforms). +The general rule for all products is that the path to the binaries +should be set via PATH +environment variable, path to the libraries should be set via LD_LIBRARY_PATH variable and the +python modules should be available via PYTHONPATH +variable. +Note: the information given in +this section refers to the pre-requisite products for SALOME version +3.2.0. + + gcc 3.4.1 + + +Version number is checked by gcc +-dumpversion command. gcc +executable should be in the PATH +environment variable. Version should +be equal to the "3.4.1". It is recommended to use native gcc on +Mandrake 10.1. + + tcl/tk 8.4.5 + +Version number for tcl/tk can +be found in tclConfig.sh and tkConfig.sh files (TCL_VERSION and TK_VERSION variables +correspondingly). Version number should be equal to "8.4" (release +number is not checked). +Set TCLHOME environment +variable to the root directory of tcl/tk installation. +It is recommended to use native tcl/tk on Mandrake 10.1. + + boost 1.31.0 + +Version number is defined by version.hpp +file which is part of the boost distribution. This file defines BOOST_VERSION macro which should be +equal to the "103100". In addition the existence of boost libraries is +checked. +Set BOOSTDIR +environment variable if you have preinstalled version of +boost. + + Python 2.3.4 + +Version number is checked by python -V +command. python executable +should be in the PATH +environment variable. Version number should be equal to "2.3.4". It is +recommended to use native Python on +Mandrake 10.1. +Set PYTHONHOME environment +variable if you have preinstalled version of Python. + + Swig 1.3.24 + +Version number is checked by swig +-version command. swig +executable should be in the PATH +environment variable. Version number should be equal to "1.3.24". + + Qt 3.3.3 + +Version number is defined by qglobal.h +file which is part of the Qt distribution. This file defines QT_VERSION_STR macro which should be +equal to "3.3.3". It is recommended to use native Qt on Mandrake 10.1. +Set QTDIR environment +variable if you +have preinstalled version of qt. + + msg2qm + +msg2qm is Qt tool which is used +to convert text .po files to .qm resource files. Unfortunately this tool -is not included to the Qt distribution and provided only in its sources -package. We distribute this tool with the Installation Wizard. -In addition there is no way to check the version number of msg2qm tool. -
Qwt 4.2.0/0.4.2	1) QWTHOME variable should be set. - 2) check if -libqwt.so.4.2.0 exists -	set QWTHOME if -you have preinstalled version of qwt	Unfortunately there is no strict way to check qwt version -number. -We try to find libqwt.so.4.2.0 in the ${QWTHOME}/lib -folder.
Hdf 5-1.6.3	1) HDF5HOME variable -should be set. - 2) existence of -libhdf5.so.0.0.0 - 3) existence of -libhdf5.settings - 4) ver=`grep "HDF5 Version:" -${HDF5HOME}/lib/libhdf5.settings \| awk -'{print $3}'`	set HDF5HOME if you -have preinstalled version of hdf	We try to find libhdf5.so.0.0.0 and libhdf5.settings in -${HDF5HOME}/lib folder. -File libhdf5.settings contains the following version information: -HDF5 Version: 1.6.3
Med 2.2.2	1) MED2HOME variable -should be set. - 2) existence of -libmed.so.1.0.1	set MED2HOME if you -have preinstalled version of med	Unfortunately there is no strict way to check med version -number. -We try to find libmed.so.1.0.1 in ${MED2HOME}/lib -folder. -If you have problem with preinstalled version of med reinstall it.
Vtk 4.2.6	1) VTKHOME variable -should be set. - 2) existence of -libvtkCommon.so	set VTKHOME if you -have preinstalled version of vtk	Unfortunately there is no strict way to check VTK version -number. -We try to find libvtkCommon.so in ${VTKHOME}/lib/vtk -folder. -If you have problem with preinstalled version of vtk reinstall it.
Netgen 4.3 -	NETGENROOT -variable should be set.	set NETGENROOT -if you have preinstalled version -of Netgen. -	Unfortunarely we can't find anything about -netgen version. -We just check if NETGENROOT +is not included to the Linux distribution and provided only in Qt +sources +package. This is the reason why this tool is suppplied with the SALOME +Installation Wizard. +There is no way to check the version number of msg2qm tool. Just set MSG2QM_ROOT environment +variable if you have preinstalled +version of msg2qm tool + + Open CASCADE 6.1.0 + +Version number is defined by Standard_Version.hxx +file which is part of the Open CASCADE distribution. This file defines OCC_VERSION_MAJOR, OCC_VERSION_MINOR and OCC_VERSION_MAINTENANCE macros which +should refer to version 6.1.0. +Set CASROOT environment +variable if you have preinstalled version of Open CASCADE. + + qwt 4.2.0/0.4.2 + +Version number is defined by qwt_global.h +file which is part of the qwt distribution. This file defines QWT_VERSION_STR macro which should +be +equal to "4.2.0". +Set QWTHOME environment +variable if you +have preinstalled version of qwt. + + hdf 5-1.6.3 + +Version number is defined by libhdf5.settings +file which is part of the hdf5 +distribution. Version should be equal to 1.6.3. +Set HDF5HOME environment +variable if you +have preinstalled version of hdf5. + + med 2.2.3 + +Unfortunately there is no formal way to check med version +number. We check existense of libmed.so.1.0.2 library on the computer. +If you have problem with preinstalled version of med, please, reinstall +it. +Set MED2HOME environment +variable if you +have preinstalled version of med. + + Vtk 4.2.6 + +Unfortunately there is no formal way to check VTK version +number. We just check existence of libvtkCommon.so +library on the computer and hope that it is of version we need. If you +have problem with preinstalled version of Vtk, please, reinstall it. +Set VTKHOME environment +variable if you +have preinstalled version of Vtk. + + OmniORB 4.0.5, OmniORBpy 2.5, OmniNotify 2.1 + +We just check existence of some omniORB libraries and executable on the +computer, like libomniORB4.so.0.5, +_omnipymodule.so.2.4, libCOSNotify4.so.0.1 and notifd. +Set OMNIORBDIR environment +variable if +you have preinstalled version of omniORB products. + + sip 4.1 + +Version number is checked by sip -V +command. sip executable should +be in the PATH +environment variable. Version number should be equal to "4.1". +Set SIPDIR environment +variable to the +directory where you have sip executable preinstalled. + + PyQt 3.13 + +Version number is defined by pyqtconfig.py +Python module file which is part of the PyQt distribution. Version should be +equal to "3.13". +Set PYQTDIRenvironment +variable if you +have preinstalled version of PyQt. + + netgen 4.5 + +Unfortunarely we can't find anything about +netgen version. We just check if NETGENROOT environment varible is set. -
OmniORB 4.0.5, -OmniORBpy 2.5, -OmniNotify 2.1	1) OMNIORBDIR -variable should be set. - 2) existence of -libomniORB4.so.0.5 - 3) existence of -_omnipymodule.so.2.4 - 4) existence of -libCOSNotify4.so.0.1 - 5) existence of notifd -	set OMNIORBDIR if -you have preinstalled version of omni	We try to find several omni libraries and binaries in the ${OMNIORBDIR}/lib and ${OMNIORBDIR}/bin directories. - -
Numeric 23.7	ver=`python -c -'import Numeric; print Numeric.__version__' -2>/dev/null`	add the directory where you +Set NETGENROOT +environment +variable if you have preinstalled version +of netgen mesher. + + Numeric 23.7 + +Version number is checked by python +-c +'import Numeric; print Numeric.__version__' command. python executable should be in the PATH +environment variable and Numeric +module should be avaible for the Python (for example it should be in +the PYTHONPATH environment +variable). Version number should be equal to "23.7". If you have +problem with preinstalled version of Numeric 23.7, please, +reinstall it. +Add the directory where you have preinstalled version of Numeric -package to your PYTHONHOME variable -	If you have problem with preinstalled version of Numeric 23.7 -reinstall it.
Sip 4.1 -	1) SIPDIR variable -should be set. - 2) ver=`${SIPDIR}/sip -V -\| awk '{print $1}'`	set SIPDIR to -directory where you have sip preinstalled	ver should be equal -to 4.1. - -
PyQt 3.13	1) PYQTDIR variable -should be set. - 2) existence of qt.so -library -	set PYQTDIR to -directory where you have PyQt preinstalled	Unfortunately we can't check exact PyQt version number. -We just try to find qt.so in ${PYQTDIR}. - -
HappyDoc 2.1	1) existence of -happydoc - 2) ver=`happydoc \| grep "HappyDoc -version 2.1"`	add the directory where you have HappyDoc -installed to your PATH +package to the PYTHONHOME environment variable. -	We try to find happydoc in ${PATH}. - - ver should not be empty. - - Note: this product is not -obligatory for SALOME compilation. -
Doxygen 1.3.7	1) existence of -doxygen - 2) existence of doxytag - 3) existence of doxywizard - 4) ver=`doxygen --version`	add the directory where you have doxygen binaries -preinstalled to the PATH -variable.	doxygen, doxytag, doxywizard binaries should -exist; ver should be equal to -1.3.7. - -If you have problem with preinstalled version of doxygen -reinstall it. - -It is recommended to use native doxygen on Mandrake 10.1. -
Graphviz 2.2.1 -	1) existence of dot -binary. - 2) ver=`dot -V 2>&1 \| awk -'{print $3}'`	add graphviz bin directory to the PATH environment variable	We try to find dot program in the ${PATH}. - ver should be equal to -2.2.1. -
MODULE binaries -(where MODULE = KERNEL, GUI, -GEOM, ...) -	1) MODULE_ROOT_DIR -variable should be set - 2) existence of VERSION -file - 3) ver=`cat ${MODULE_ROOT_DIR}/bin/salome/VERSION -\| awk -F: '{print $NF}' \| -tr -d '[:space:]'`	set MODULE_ROOT_DIR -if you have preinstalled binaries of MODULE.	MODULE binaries -should exist and ver should be -equal to <version>, where <version> is version number -being installed. -
MODULE sources -(where MODULE = KERNEL, GUI, -GEOM, ...) -	1) existence of MODULE_SRC_DIR - 2) existence of VERSION -file - 3) ver=`cat ${MODULE_SRC_DIR}/bin/VERSION \| awk --F: '{print $NF}' \| tr -d -'[:space:]'`	set MODULE_SRC_DIR -if you have preinstalled sources of MODULE. -	MODULE sources should -exist and ver should be equal to <version>, where <version> -is version number -being installed.

Note: For native products installation procedure sets proper -environment variables itself, and you do not need to set such variables -like, e.g. TCLHOME or PYTHONHOME.
-If you have native products installed to different from default +

graphviz 2.2.1

+Version number is checked by dot -V +command. dot executable should +be in the PATH +environment variable. Version number should be equal to "2.2.1".
+Add graphviz bin directory to +the PATH environment variable.
+

doxygen 1.4.6

+Version number is checked by doxygen +--version command. doxygenexecutable +should be in the PATH +environment variable. Version number should be equal to "1.4.6".
+

SALOME module + sources +(3.2.0).

+For each SALOME module sources package (KERNEL, GUI, GEOM, etc...) bin directory contains file VERSION which defines version +information.
+Set <MODULE>_SRC_DIR +environment variable for each SALOME MODULE +sources package installed (where MODULE +is KERNEL, GUI, GEOM, ...).
+

SALOME module + binaries (3.2.0)

+For each SALOME module binaries package (KERNEL, GUI, GEOM, etc...) bin/salome directory contains file VERSION which defines version +information.
+Set <MODULE>_ROOT_DIR +environment variable for each SALOME MODULE +binaries package installed (where MODULE +is KERNEL, GUI, GEOM, ...).
+

If you have native products installed to different from +default directories (not /usr/bin, /usr/lib...), it is -recommended to follow above description. Or you should set properly PATH and PATH and LD_LIBRARY_PATH variables before -starting Installation Wizard. Otherwise -installation script will fail to find preinstalled products.

+starting the Installation Wizard. Otherwise +the installation script will fail to find preinstalled/native products. +

Note: For some native products (e.g. gcc, Python) the rules of version checking are not so strict as described in the table. Only major and minor numbers of version -should coincide with prerequisite. Release number can be larger. It is -done for making a possibility -to use native products for newer versions of Linux. -If some native product has version number larger than that required by +should coincide with prerequisite. Newer version of the product can be +used also. If some native product has version number larger than that +required by the installation procedure, user will be prompted by the warning message like this: "You have @@ -811,35 +722,40 @@ SALOME binaries (including other products) are compiled with the predefined prerequisites and most likely can not be run successfully if these products are not found. -This can be only helpful if you intend to build all products from -sources.

+This can be only helpful if you plan to build all products from +sources.
+

Pick up the environment
Please, read carefully the following information. This section -describes how the installation procedure collects the environment. -
After installing each product shell script creates special -environment file for each product in its target folder . The name of +describes how the installation procedure generates the environment +scripts for the SALOME platform being installed. +
After installing of each product shell the script creates special +environment file for the product in its installation folder. The name +of the file is generated from -the name of product by the following scheme: env_<product_name>.sh. -This file includes all necessary product settings. For example for Vtk -the file is env_Vtk.sh. Environment files allows to pick up all -environment settings which are necessary to build and launch SALOME. -When installing SALOME -sources and/or binaries, installation procedure picks up all the -settings files and generate two scripts: salome.sh and salome.csh -for sh and csh correspondingly. Such approach helps to save time +the name of product by the following scheme: env_<product_name>.sh +(for example env_Vtk.sh for the Vtk). +This file includes all necessary environment settings. At the final +step of the installation the script picks up all the +settings files and generate from them two common environment files: salome.sh +and salome.csh +for bash and csh shells correspondingly. Such +approach helps to save time when reinstalling products and you may not to care about setting all environment variables -manually to build/launch SALOME. What you need is just to use one of +manually to build/launch SALOME. What you need is just to source one of these -scripts.
-
This concerns also those products which are not currently installed. +environment files.
+
This concerns also those products which are not being installed. For example, you install some SALOME binaries to the directory where you have previously installed other products. Installation -procedure still tries to collect environment files from the target -directory if it finds necessary products there. If some product is not +procedure tries to collect environment files from the target +directory if it finds necessary products installed there. If some +product is not found in the target directory the corresponding section of salome.sh/salome.csh files will be skipped.
For native products (like gcc, tcl, etc...) @@ -848,23 +764,28 @@ installation procedure tries to find them first using PATH directories (/usr/bin, /usr/lib etc., depending on the product).

In any case you may edit salome.* files after installation -procedure finishes, as you want.
-Note: as it was mentioned above there are two more environment files which +procedure finishes, if you want.
+
+Note: as it was mentioned above there +are another environment files which are generated by the installation procedure: env_products.csh and env_products.sh. These files can be + style="font-weight: bold;">env_products.csh + env_products.sh and env_build.csh + env_build.sh. These files can be found in the target installation root directory.

Modifying XML configuration file
-You can create your own configuration file. -Installation Wizard then can take it as command line argument to +You can create your own XML configuration file. +The Installation Wizard then can take it as command line argument to provide list of products you want to install with it. The list of products and some another settings for the Installation Wizard are -provided in XML file. The default file which Installation Wizard looks -for if no command line arguments are given, is config.xml. This +provided in the XML file. The default file which Installation Wizard +looks +for if no command line arguments are given, is config.xml.
+This section describes the structure of the configuration file.
XNL tags are in bold blue, optional sections/tags are in brackets. @@ -945,94 +866,162 @@ dependancies=<list_of_prerequisites>

<config> section
-This is optional section - contains general -information Installation Wizard itself. +This is optional section; it provides general +information Installation Wizard itself.
+
+Attributes:
+
-
version: Installation Wizard's -version number;
-
caption: Installation Wizard's -main -window title - if this string contains '%1' text - the title will +
version
+
+The application version number to be shown in the +caption. +
+
caption
+
+The application main window caption - if this +string contains '%1' text the title will contain -in this place version number (see above); -
copyright: Installation Wizard's -copyright information (appears on the first page of program);
-
license: Installation Wizard's -license information (appears on the first page of program);
-
os: Contains directory name -(relative from ./Products/BINARIES) where Installation Wizard should -search precompiled binaries packages. If this tag is skipped, binaries -are implied to be in -the ./Products/BINARIES directory.
+in this place the version number (see above). +
+
copyright
+
+The application +copyright information (shown in the first page). +
+
license

+The application license information (shown in the +first page). +
+
os
+
+This parameter defines the directory (relative +from ./Products/BINARIES) where the Installation Wizard will +search precompiled binaries packages. If this tag is not provided, +binaries packages are looked for in +the ./Products/BINARIES directory.
<path> section
-This is optional section - contains default directories. +This is optional section; it defines default installation directories.
+
+Attributes:

-
targetdir: Starting target -directory - path to the directory where products should be installed;
-
tempdir: Starting temp directory - -path to the directory for the temporary files.
+
targetdir

+The target +directory - the path to the directory where products should be +installed. +
+
tempdir
+
+The temporary directory - +the path to the directory for the temporary files.
<product> section
This section describes product to be installed with the Installation -Wizard. Products appear in the products tree +Wizard. XML file should include <product> section for each +product to be installed. The products appear in the tree view and are installed in the order they are described in the configuration -file. It is recommended to insert native products at the top of the -list before all other products. +file. It is recommended (but not obligatory) to define native products +at the top of the +list before all other products.
+
+Attributes:
+
+
name
+
+The name of the product. +
+
version
+
+The version of the product. +
+
description
+
+The product description +(optional). +
+
context
+
+Context (optional). The possible values are 'salome +sources', 'salome +binaries' and 'prerequisite' (several context can be given +separated by ":" symbol). +
+
supported
+
+Supported modes of +installation. Several modes can be separated by comma. Possible value +are: install sources, install binaries, use +native. Installation script should contain the corresponding +functions +for each of the supported installation modes (see here). +
+
install
+
+Default (starting) +installation mode.
-
name: Name of the product;
-
version: Version of the product;
-
description: Description of the -product (optional);
-
context: Context of the product -(optional); the possible values are 'salome sources', 'salome -binaries' and 'prerequisite';
-
supported: Supported modes of -installation, should contain one or more of the following options, -separated by comma: install sources, install binaries, use -native. Installation script should contain corresponding functions -for each of supported installation modes;
-
install: Default (starting) -installation mode;
-
disable: If this flag has 'true' -value, corresponding product will not appear in the list of products -tree and will not be installed;
-
pickupenv: This flag points that pickup environment +
disable
+
+If this flag has 'true' +value, the corresponding product will not appear in the list of +products and will not be installed. +
+
pickupenv
+
+This flag points that pickup environment procedure -should be performed for this module. If this flag equal to true, +should be performed for this product. If this flag equal to 'true', salome.sh and salome.csh files will be created in the product's installation directory. Usually this option is set to true for SALOME KERNEL module -sources and binaries pakcge. This is optional key, default value is false.
- -
dependancies: list of prerequisite -products, which are necessary to build this product, separated by comma;
-
installdiskspace: Total amount +sources and binaries package. This is optional key, default value is +'false'.
+
+
dependancies
+
+List of prerequisite +products, which are necessary to build this product, separated by comma. +
+
installdiskspace
+
+Total amount space (integer, in Kbytes), which product occupies on the hard drive after the -installation;
-
temporarydiskspace: Disk space +installation. +
+
temporarydiskspace
+
+Disk space (integer, in Kbytes) for the temporary files, which is necessary to -build the product from the sources;
-
script: Installation script name. -This script is in charge of installation of the product. It is called -when necessary from the main program. See next -section for -more information.
+build the product from the sources. +
+
script

-Note: If you add new products to be installed with Installation +The installation script name. +This script is in charge of the installation of the product. It is +called +automatically by the Installation Wizard when necessary from the main +program. See the next +section for +more information.
+
+Note: If you add new products to be installed with Installation Wizard, you should also provide installation script for this product. See -next section for more details. +the next section for more details.

Implementing installation scripts for the new products
When you want some product to be installed with the Installation Wizard, you should add it's description it in the -configuration file and create bash installation script, following -described in this section rules.
-There are some obligatory functions to be provided in this installation +configuration file and create the installation script, following +rules described in this section.
+
+There are some obligatory functions which should be implemented in this +installation script. These functions are automatically called by master installation script or/and its GUI shell when it is necessary.
@@ -1043,58 +1032,88 @@ make_dir(), try_existing(), sort_path(), find_in_path(), etc.
-
check_version(): This function allows to check the +
check_version()
+
+This function allows to check the version of the product already installed on the computer. It should try to find product (native or preinstalled in the target directory) and check -it version. This helps to avoid unnecessary reinstallation. This is +its version. This helps to avoid unnecessary reinstallation. This is internal -function and is not called -
try_native(): This function is +function and is not called from the master installation script.
+
+
try_native()
+
+This function is called when 'use native' installation mode is selected by the user. The function should try to find native version of the product and -define possibility of it usage. Should create environment for the +define possibility of its usage. It should create the environment file +for the product in the temporary directory (see also description of print_env() -function). If you do not provide native mode installation, you can omit -this function.
-
install_source(): This function is +function). It is not necessary to +implement +this function if you do not provide native +mode. installation.
+ +
+
install_source()
+
+This function is called when 'install sources' installation mode is selected by the user. The function is responsible for the building of the product from the -sources package. Should create environment for the product in the +sources package. It should create the environment file for the product +in the temporary -directory (see also description of print_env() function). If -you do -not provide sources mode installation, you can omit this function
-
install_binary(): This function is +directory (see also description of print_env() function). It is not necessary to +implement +this function if you do not provide sources mode installation. +
+
install_binary()
+
+This function is called when 'install binaries' installation mode is selected by the user. The function is responsible for the extracting of the product from -the binaries package. Should create environment for the product in the +the binaries package. It should create environment for the product in +the temporary -directory (see also description of print_env() function). If -you do -not provide binaries mode installation, you can omit this function.
-
try_preinstalled(): This function +directory (see also description of print_env() function). It is not necessary to +implement +this function if you do not provide binaries mode +installation.
+ +
+
try_preinstalled()
+
+This function is called when 'not install' installation mode is selected by the user. In this case script should inspect target directory to try to find already preinstalled product, pick up and check environment from -there. See here for more details.
-
print_env(): This function is in +there. See here for more details. +
+
print_env()
+
+This function is in charge of creation environment script. It should create file with name env_<product_name>.sh in the temporary directory and then copy it into the product installation directory. The file should contain all necessary environment variables settings for the product. It will be collected -during the 'pick-up-environment' procedure.
-
pickup_env(): This procedure corresponds pickupenv +during the 'pick-up-environment' procedure. +
+
pickup_env()
+
+This procedure corresponds pickupenv tag -of the configuration xml file (see previous section). Should call make_env +of the configuration xml file (see previous section). It should call make_env procedure to perform pick-up environment procedure for the product.
-
-

SALOME Installation -Wizard Help

SALOME Installation +Wizard Help

Installing products with the Installation Wizard

GUI mode

Batch mode
+

Environment files

Batch mode
-

Notes on check products version procedure

Pick up the environment

Modifying XML configuration file

<config> section

<path> section

<product> section

Implementing installation scripts for the new products

SALOME Installation -Wizard Help

SALOME Installation +Wizard Help

Installing products with the Installation Wizard

GUI mode

Batch mode +

Environment files

Batch mode -

Notes on check products version procedure

Pick up the environment

Modifying XML configuration file

<config> section

<path> section

<product> section

Implementing installation scripts for the new products

Batch mode
+

Batch mode
-