- Installing products with the -Installation Wizard -
- Notes on check products version -procedure +Installation Wizard
- GUI mode +
- Batch mode +
- Environment files
+
+ - Pick up the environment
- Modifying XML configuration file
- Implementing installation scripts for the new products +
- Customizing Readme page buttons
+ +
-
+
Installing products with the Installation Wizard
-The Installation Wizard can be launched in two modes: gui and batch.+The Installation Wizard can be launched in two modes: GUI and batch.
The root directory of the Installation Wizard -contains python script runInstall. -To run the Installation Wizard just type runInstall in terminal -window:
-
[ python ] runInstall [ -g | -b ] [ -f <xml-file> ] [ -t -<target-dir> ] [ -tmp <tmp-dir> ]
--g
- Runs the Installation Wizard in the
+contains Python script runInstall.
+To run the Installation Wizard just type ./runInstall in the
+terminal
+window:
+
[ python ] ./runInstall [options]
+
Without options this script will launch the SALOME Installation
+Wizard in the GUI mode.
+The default installation settings can be overridden by using of command
+line options. Each option has short and long notations:
+
-g / --gui
+
--b
- Runs the Installation Wizard in -command-line mode.
--f <xml-file>
- The configuration file to be used by -the -Installation Wizard. If this parameter is missed then the script -tries -to define the Linux version and uses corresponding xml file. -For -examle, for the Linux Mandrake 10.1 config_Mandrake10_1.xml +mode (this is the default mode).
+
-b / --batch
+
+
-f FILE / --file=FILE
+
--t <target-dir>
- The target directory, SALOME platform -to -be installed to. If used, overloads default target directory, given in -the -configuration -xml file (usually /salome, see -here).
--tmp <tmp-dir>
- The directory, which is used to -contain temporary files. If used, overloads default temporary -directory, -given in the -configuration xml file (usually /tmp, see here).
--h
- Prints help information.
+will be used by default. +
-d DIR / --target=DIR
The installation procedure can support some different Linux
-platforms
-and various number of products. As it was mentioned above the basic
-target platform for SALOME 3.0.0 and higher is Linux Mandrake 10.1.
-The using of configuration xml files gives flexible way to modify the
-list of products to be installed by the Installation Wizard without
-changing program's source code. Just create your own configuration file
-and implement installation scripts for products you want to be provided
-by Wizard. See modifying XML configuration file
-and implementing installation scripts for the
-new products for more information.
The Installation Wizard was built with -using of the Trolltech's Qt -3.0.5 library. The program contains -several pages. To navigate between pages use "Next" and "Back" -buttons in the -lower part of the wizard window. "Cancel" button closes dialog -window -and quits the installation procedure. To invoke this help information -click -"Help" button.
-Skip the first "Introduction" page by pressing "Next" -button: +
+
-t DIR / --tmp=DIR
++
-a / --all-from-sources
++This option is helpful when the user wants to install SALOME on the +platform which is not officially supported. In this case, the user can +try to run the SALOME Installation Wizard with the -a option in order to build all the +products from sources.
+Note, that this is long-time operation which can take more than +24 hours depending on the computer.
+
-s / --single-directory
++This option is ignored when --all-from-sources (-a) option is used. +
-h / --help
+
+
+-v / --version
+
+
+
+The installation procedure supports different Linux
+platforms and installs various 3d-party installation prerequisite products, which
+are required by SALOME platform. Among supported Linux platforms there are Mandriva 2008
+(32bit and 64bit), Mandriva 2010 (32bit and 64bit), Debian 4.0 Etch (32bit and 64bit),
+Debian 5.0 Lenny 64bit, Debian 6.0 Squeeze 64bit and other ones.
+The usage of configuration XML files provides a flexible way to modify
+the list of products to be installed by the Installation Wizard without
+changing the source code of the application. Just create your own XML
+configuration file and implement installation scripts for the prerequisite products you
+need and then use this XML file with the Installation Wizard. This can
+be done, for example, for some Linux
+platform which is not supported directly by the
+Installation Wizard. See Modifying XML
+configuration file and Implementing installation
+scripts for the new products sections for more information.
GUI
+mode
+
+The GUI of the Installation Wizard has been +developed with Qt +3.3.8 toolkit by +Trolltech . After launching the Installation Wizard +in the GUI mode the wizard window is shown to the user. This wizard +guides the user through several subsequent pages. To navigate between +the pages use "Next" and "Back" +buttons in the lower part of the wizard window. "Cancel" button +closes the wizard window and quits the installation procedure after user +confirmation. "Help" button opens a window with the help information.
+The first "Introduction" +page is shown in Figure 1. +Skip this page by pressing "Next" 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 Qt's
-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 has two modes of the installation: basic -(default) and -advanced. In the basic mode it is necessary just to enter target -directory. If you want -to use advanced mode, click "More..." button.
-In the advanced mode you have the possibility to select products to
-be installed (see Fig.2 ). Each product can
-have several options of installation: you have a possibility to use
-native products, 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
-products you want to install by clicking the corresponding
-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
-has a special feature to automatically mark these products in the list
-view.
-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.
-This feature can be switched off by clicking "Auto set
-prerequisites products" checkbox.
-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.
+
In the second page you are proposed to select the type of the
+SALOME installation.
+
+At this step three possible types of installation are available:
+
-
+
- "Install binaries"
+type:
+-
+
- all binaries and sources of the chosen modules are +installed; +
- all binaries of the chosen prerequisites are installed. +
+
+ - "Install sources"
+type:
+-
+
- all sources of the chosen modules and prerequisites are +installed without compilation. +
+
+ - "Install sources and
+make compilation" type:
+-
+
- all sources of the chosen modules and prerequisites are +installed; +
- all sources are compiled. +
+
In case you select "Install sources and make compilation" +installation type, then you can also check "Remove sources and +temporary files after compilation" option. +
++
+Figure 2: "Type of installation" page +
+After the installation type has been selected you click "Next" +button and the Installation Wizard tries to determine the Linux +platform to load the corresponding configuration file. If the operating +system is not defined or the current SALOME package does not support +this system, the warning message will appear ("Install binaries" +and "Install sources" installation types only): +
++
+Figure 3: "Installation platform" page +
+If "Install sources and make compilation"
+installation type has been selected, the warning message will be
+slightly different: "Your Linux platform is not supported by
+this SALOME package and compilation is not tested on this one".
+There is a list of all platforms supported by SALOME, but only those
+supported by the current package are available for selection. in this
+page you need to to select the reference platform, if you wish to
+proceed with the present installation procedure.
+Note: this page is not displayed if the installation
+platform has been defined automatically.
+
In the next page you are proposed to enter the target
+installation directory for SALOME platform. You can also press "Browse..."
+button and choose the destination folder using the standard browse
+directory dialog box.
+If the necessary directory does not exist you are
+prompted to confirm the directory creation. If you type a wrong
+directory
+path, or if you do not have the permissions to write to the chosen
+directory, the corresponding message box is shown.
+
Note: you are strongly recommended to avoid using +directory names containing spaces. Otherwise you can +experience some troubles with the +installation. +
++
+Figure 4: "Installation directory" page +
+You can select the products to be installed in the "Choice of
+the products to be installed" page.
+In the default mode it gives you the possibility to view and select
+SALOME modules only. There is a hidden list of 3d-party prerequisite
+products. To show it, just click "Show prerequisites..."
+button.
+
+
+Figure 5: Choice of the SALOME modules +
+In the full mode you also have the possibility to select
+prerequisites.
+The checkbox before each product indicates if this one will be
+installed or not (checked or unchecked). The second column shows the
+disk space occupied by the corresponding module. This value depends on
+the selected type of installation.
+To hide the prerequisites list - click "Hide prerequisites"
+button.
+
+Figure 6: Choice of the prerequisites +
++Some products may require some other prerequisite products to be +installed. So the installation procedure has a special feature to +automatically mark these products in the list view. For example, to +install PyQt it is necessary to have gcc, Python, Qt and Sip installed, +and these products will be also turned on when you check on PyQt. GEOM +module requires KERNEL, GUI modules and such prerequisites as: +OpenCascade, Python, Swig, Qt, etc. +
+The dependencies between SALOME modules are managed in the +following way: +
+-
+
- If one module is unchecked, all modules which depend on +this one are also unchecked automatically; +
- If one module is checked, all modules required for this one +are also checked automatically. +
Dependency between modules and prerequisites is realized in +the following way:
-There are also two checkboxes on this page: "SALOME sources" -and "SALOME binaries". -These three-state checkboxes allow quick selecting/unselecting SALOME -itself 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 -disk space, disk space required for temporary files, list of -prerequisites and current user -choice. +
-
+
- The choices made by the user in the list of modules have a +direct impact on the list of prerequisites; +
- Whenever a module is checked, all the necessary +prerequisites are checked automatically with no possibility for the +user to uncheck them (see Fig.7 +below); +
- Whenever a module is unchecked, according to the remaining +checked modules, the unnecessary prerequisites are unchecked +automatically (see Fig.7 +below). +
+
+Figure 7: Dependencies between modules and +prerequisites
--
-Figure 2: "Installation settings" page in the advanced mode
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
-required disk space is approximate and may differ when you install
-products on your hard drive.
The "Installation with GUI" checkbox allows
+managing the installation of the graphical interface. Only modules for that
+'woguimode' attribute is set to "true" value in the XML file
+(see here for more information about
+customizing this installation mode) support without GUI mode and
+will be checked and installed with their necessary prerequisites in
+case of installation without GUI. And other modules are unchecked with no
+possibility to check them in this mode (see figure below).
+By default 'Installation with GUI' checkbox is switched on.
+
+
+Figure 8: Installation without GUI mode +
+The box at the right side of the page displays the information +about the currently selected product: name, version and short description, +required disk space, disk space required for the temporary files and +the list of prerequisites (this information is provided in the XML +file). +
+The "Disk space required:" field displays
+how much
+disk space on the hard drive is required for installation of the
+selected
+products.
+Note: please, take into account that the displayed
+amount of
+the required disk space is approximate and may differ when you actually
+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
-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
-something like INSTALLWORKXXXXX
-where XXXXX is unique number. This allows to launch several
+temporary files. The "Space for temporary files"
+field shows
+the information about the required disk space on the hard drive for
+extracting and compiling the selected products. You can change the
+temporary directory (this information is provided in the XML file) to
+the folder you want.
+Note:
+actually, the temporary files
+are not stored directly in the directory selected by the user. The
+Installation Wizard creates in this directory an additional folder
+named
+like INSTALLWORKXXXXX
+where XXXXX is a unique number. This allows launching several
Installation Wizards simultaneously. This temporary directory is
-removed automaticaly when the installation finishes.
+removed automatically when the installation finishes.
+
The installation procedure also checks the available disk +space. If +there is not enough disk space on your hard drive you will see the +corresponding error message box. +
+Also in the current version of Installation Wizard is possible
+to install all binaries of the selected SALOME modules into a single
+directory. It is "SALOME" directory.
+For this purpose there is a checkbox "Install modules to a
+single directory" checkbox exists (see Fig.8).
+This feature helps to get shorter PYTHONPATH and LD_LIBRARY_PATH
+environment variables.
+Note: the installation into a single directory is
+available with the binaries installation type only.
+
To proceed further, click "Next" button. +At this moment +the program will make some tests to check the installation settings: if +there is enough disk space on the hard drive, check for the +dependencies for each product you have selected to be installed. If any +test fails you will see the corresponding warning message box. +Otherwise the wizard will proceed to the next page: +
++
+Figure 9: "Check your choice" page
-The installation procedure also checks available disk space on the -selected directories according to the products selected. 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 -annoying bug under Linux platform. The directory should be obligatory -entered without spaces. For example, the configure procedure for gcc -won't -work if you pass the following parameter: --prefix="/New Folder 1". -Therefore you are strongly recommended not to use directory names -containing -spaces.
-To proceed further click "Next" button. At this moment -program -will make some tests to check installation settings: if there is enough -disk -space on the hard drive, if native products are preinstalled, -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:
-Figure 3: "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.
-When you are sure that everything is OK, press "Next" button to
-follow to the next page.
-
-Figure 4: "Installation progress" page
+This page summarizes the installation options you've selected
+in the
+previous pages. You can review again your choices and change them if
+necessary returning to the previous pages.
+When you are sure that everything is OK, press "Next"
+button to
+follow to the progress page.
+
+
+Figure 10: "Installation progress" page: +not started yet +
To start installation of the selected products click "Start" +
-Note: press [Enter] when you finish typing data. -
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". -All installed products have "Completed" -description.
-You can abort installation and close the installation procedure -using -"Cancel" button. It sends the signal "SIGTERM" to the shell -script. -The script has a signal handler and will try to clear all temporary -files. -The process of removing temporary files can take some time, so the -installation -wizard will wait 3 seconds before closing.
-At the end of installation (all selected products have been -installed -successfully) you can go back to the previous pages to start a new -installation -or click "Next" button to go the Readme page:
-Figure 5: "Finish installation" page
+to see the output of the script in the topmost frame of the dialog box. +If any errors occur during the installation progress, the corresponding +messages will be printed to the log window in the bold red font and +installation process will be aborted with error message box. But user +has possibility to change this default behaviour by +"Ignore errors" checkbox. It is necessary to check +it before start and all occured errors will be passed, +and installation will be continued in any case.+
+
Note:
+in the current
+implementation it is not possible to resume the stopped installation
+process; the installation will restart from the very beginning.
+
+
+Figure 11: "Installation progress" page: +installation in +progress +
+The "Installation Status" frame window +shows you the +progress of installation. "Waiting" +status +means that the installation of this product has not started +yet. The product currently being installed is marked as "Processing" and is displayed in +the status bar under "Installation Status" view. All installed products +have "Completed" +status. +
+You can abort the installation and close the installation
+procedure
+using "Cancel" button.
+Note: this
+button sends the
+signal "SIGTERM" to the shell script.
+The script tries to clear all temporary files.
+The process of removing the temporary files can take some time, so the
+installation wizard will wait for 3 seconds before closing.
+
At the end of the installation "Installation completed" +message will appear in the status bar. You can return to the previous +pages to start a new installation or click "Next" +button to go to the readme page:
++
+Figure 12: "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
-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
+Installation Wizard itself and some tips: how to run and test SALOME or
+how to build SALOME from the sources. This is also described the
+README file which you can find in the root directory of the
+Installation Wizard.
+You can also launch SALOME Desktop from this
+page or read the Release Notes file by clicking on the corresponding
+buttons in the lower part of the page (see here
+and here for more
+information about
+customizing these buttons).
+
Batch mode
+
+To launch the Installation Wizard in the batch mode use -b
+(--batch) parameter.+In this mode the GUI wizard is not shown but all the installation +status is displayed directly in the console. 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.
+There are two exceptions: --all-from-sources +(-a) option which enables +special installation mode in which all the products (including SALOME +modules) are installed from sources, ignoring default mode defined in +the XML configuration file (see here +for details) and --single-directory (-s) option which defines +that all SALOME modules have to be installed into the one directory +(SALOME_<version>, by default, where <version> is SALOME version). +
+
+
+Figure 9: Batch mode
+Environment +files
+During the process of installation the
script creates some
-environment files to simplify procedure of launching SALOME. These
+environment files to simplify the procedure of launching SALOME. These
shell scripts set
all necessary environment variables for all products you have
installed.
-To learn how installation scripts collects the environment, see here. These files are: salome.csh + salome.sh
-in the KERNEL module sources
+To learn how the installation scripts collect the environment, see here. These files are: salome.csh
++ salome.sh
+in the KERNEL module
+sources
and KERNEL
-module binaries root directories and env_products.csh
-+ env_products.sh in the target directory.
+module binaries
+root directories and env_products.csh
++ env_products.sh and env_build.csh
++ env_build.sh
+in the
+target installation directory.
-
- +which is set to 0 +in +env_build.* files and to 1 +in +env_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.- -
|
- |
-
- |
-
- - of installation procedure |
-
- |
-
|---|---|---|---|
| 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 5.2.3 - |
- 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="$ver_major.$ver_minor" - 5) Check existence of -libStdPlugin.so in OpenCASCADE distribution, - |
- set CASROOT if you -have preinstalled version of Open CASCADE | -CASCADE's Standard_Version.hxx file provides version
-information. - ver should be equal to -5.2. - -Unfortunately there is impossible to define release version number. -Instead we check if libStdPlugin.so library exists: it is introduced in -OpenCASCADE from version 5.2.2. - |
-
| 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
-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 -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
-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
-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 -version 3.0.0. | -MODULE binaries
-should exist and ver should be
-equal to 3.0.0. - |
-
| 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
-version 3.0.0. - |
- MODULE sources should -exist and ver should be equal to 3.0.0. | -
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
-directories (not /usr/bin, /usr/lib...), it is
-recommended to follow above description. Or you should set properly PATH and LD_LIBRARY_PATH variables before
-starting Installation Wizard. Otherwise
-installation script will fail to find preinstalled 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 -the -installation procedure, user will be prompted by the warning message -like this: "You have -newer version of gcc installed -on your computer than that is required (3.4.1). Continue?". You can -press "Yes" button -to procede with the installation but in this case you should be aware -of what you are doing. -SALOME binaries (inluding 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.
-
-
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 -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 -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 -these -scripts.
-This concerns also those products which are not currently installed. +describes how the installation procedure generates the environment +scripts for the SALOME platform being installed. +
After the installation of each product the shell script +creates a special +environment file for the product in its installation folder. The name +of the file is generated from the name of the 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 settings files and +generates from them two common environment files: salome.sh +and salome.csh +for bash +and csh +shells correspondingly. This +approach helps to save time when reinstalling products and you may can +avoid setting all environment variables +manually to build/launch SALOME. What you need is to source one of +these environment files.
+This also concerns the 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
-found in the target directory the corresponding
-section of salome.sh/salome.csh files will be skipped.
-For native products (like gcc, tcl, etc...)
-installation procedure tries to find them first using PATH
-/ LD_LIBRARY_PATH variables and then in the system default
-directories (/usr/bin, /usr/lib etc., depending on the product).
+you have previously installed other products. The
+installation
+procedure tries to collect the environment files from the target
+directory if it finds necessary products installed there. If a
+product is not found in the target directory the corresponding
+section of salome.sh/salome.csh files will be
+commented.
+For the native products (like gcc, tcl, etc...)
+the installation procedure tries to find them first using PATH
+/ LD_LIBRARY_PATH variables and then in the system
+default
+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
-are generated by the installation procedure: env_products.csh and env_products.sh. These files can be
+
In any case you are able to edit salome.*
+files after the installation procedure finished.
+
+Note: as it has been mentioned above
+there
+are other environment files generated by the installation procedure: 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 -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 -section describes the structure of the configuration file.-XNL tags are in bold blue, optional sections/tags +You can create your own XML +configuration file. +The Installation Wizard can take it as a command line argument to +provide a list of products you want to install with it. The list of +products and some other settings for the Installation Wizard are +provided in the XML file.
+This section describes the structure of the configuration file. +XML tags are in bold blue, optional +sections/tags are in brackets. -
<document>
+
+ <document>
- [ <config
-[ version=<install_wizard_version> ]
-
- [
-caption=<install_wizard_caption> ]
-
- [
-copyright=<install_wizard_copyright> ]
-
- [
-license=<install_wizard_license_info> ]
-
- [ os=<target_platform>
-]
- />
- ]
- [ <path
-[ targetdir=<target_directory> ]
-
+
+
+<config
+[ version=<application_version>
+ ]
+
+
+ [
+caption=<application_caption>
+ ]
+
+
+ [
+copyright=<application_copyright> ]
+
+
+
+ [
+license=<application_license_info> ]
+
+
+
+platforms=<target_platform>
+
+
+ [
+targetdir=<target_directory>
+ ]
+
+
+
+
+[
+tempdir=<temp_directory>
+ ]
+
+ [
+optionallibs=<optional_libraries> ]
+
+ />
+
+
+[ <buttons>
+
+
+[ <button
+
+label=<button_label>
+
+
+
+[ tooltip=<button_tooltip> ]
+
-[ tempdir=<temp_directory> ]
- />
+
+script=<button_script>
+
+
+
+[ disable=<disable_flag> ]
+ />
+
+ ]
+
+[
+<button
+...
+ />
+
+
+]
+
+...
+
+ </buttons>
+
]
- [ <product
+ [ <products>
+
+
+[
+<product
name=<product_name>
-
-
-version=<product_version>
- [
-context=<product_context>
-]
- [
+
+
+
+type=<product_type>
+
+ [
description=<product_description> ]
-
-
-install=<installation_mode>
-
-
-supported=<supported_installation_modes>
-
- disable=<disable_flag>
- [
-pickupenv=<pickup_env_flag> ]
-
-
-dependancies=<list_of_prerequisites>
-
- installdiskspace=<install_disk_space>
+
+
+<installation
+os=<installation_platform>
+
+
+
+
+version=<product_version>
+
+
+
+ [
+disable=<disable_flag>
+ ]
+
+
+
+ [
+woguimode=<without_gui_mode_flag> ]
-
- temporarydiskspace=<tmp_disk_space>
-
- script=<installation_script_name>
- />
+
+
+installdiskspace=<install_disk_space>
+
+
+ [
+pickupenv=<pickup_env_flag>
+ ]
+
+
+
+
+
+script=<installation_script_name>
+
+/>
+
+...
+
+ />
- ]
- [ <product ...
- />
+ ]
+ [ <product ...
+ />
+ ]
+
+...
+ </products>
- ]
- ...
-
-</document>
<config> section
-This is optional section - contains general -information Installation Wizard itself. + ]+ [ <dependencies> +
+ +[ +<product +name=<product_name> >
+ +[ +<dep> <prerequisite_name> + </dep> +]
+ +...
+ </product> +
+ +]
+ +...
+ </dependencies> +
+ ]
+ +</document> + +
<config> +section
+This section provides general +information about an application that will be installed.+
+Attributes:
+ +
-
+
- version +
-
+
- caption +
-
-
- version: Installation Wizard's -version number; -
- caption: Installation Wizard's -main -window title - 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. +
- copyright
<path> section
-This is optional section - contains default directories. +The application +copyright information (shown in the first page).-
-
- 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. +
- license
-
+
- platforms +
-
+
- targetdir +
-
+
- tempdir +
-
+
- optionallibs +
<buttons> section
+This is an optional section and may contains one or more +<product> sections. +<button> section
+This optional section allows customization of the last "Finish +installation" page of the Installation Wizard by adding one +or +more buttons in the lower part of the Installation Wizard window. The +script +which is attached to each such button, can perform some specific +actions, for example, launch the application or show the 'Release +Notes' +file by using an external program. +See here for more +details about +writing scripts.+
+Attributes:
+
-
+
- label +
-
+
- tooltip +
-
+
- script +
-
+
- disable +
+
<products> section
+This one contains a list of <product> sections. The +products appear in the tree view and are installed in the order they +are described in this section.<product> section
-This section describes product to be installed with the Installation -Wizard. Products appear in the products tree -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. +Current section is optional. It describes the product to be installed +with the Installation +Wizard. The <products> container should include +<product> section for each +product to be installed.+
+Attributes:
-
-
- 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
-procedure
-should be performed for this module. 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 -space (integer, in Kbytes), which product occupies on the hard drive -after the -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. +
- name +
-
+
- type +
-
+
- description +
<installation> section
+It is a part of the <product> section, that provides +installation information by platforms. The <product> +section may contains a several <installation> ones for +the different platforms. ++
+Attributes:
+
-
+
- os +
-
+
- version +
-
+
- disable +
-
+
- woguimode +
-
+
- installdiskspace +
-
+
- pickupenv +
+
-
+
- script
+
+Note: If you add new products to be +installed with Installation Wizard, you should also provide +installation script for this product. See 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 +Wizard, you should add it's description it in +the +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.
-File common.sh contains some service +File common.sh +contains some service functions which can be used in your installation script, like make_env(), make_dir(), try_existing(), sort_path(), find_in_path(), etc.
-
-
- check_version(): This function allows to check the +
- check_version() +
-
+
-
+
- install_binary()
-<product_script_name> -<function_name> <temp_folder> <products_directory> +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. It should create environment for the product +in +the temporary directory (see also the description of print_env() +function). It is not necessary to implement this function if you do not +provide binaries mode +installation for the current product.
+ +
-
+
- install_source() +
+
-
+
- install_source_and_build() +
+For more details please refer to this +section for more details.
+ +
-
+
- try_preinstalled() +
-
+
- print_env_bin() + & print_env_src() +
-
+
- pickup_env() +
+
+The calling signature of the product +installation +script is the following:
+ +<product_script_name> +<function_name> +<temp_folder> +<products_directory> <target_directory> -<dependancies> <product_name> +<all_products> +<product_name> +<install_products> +<sources_directory> +<remove_sources_flag> +<binaries_directory> +<single_directory_flag>
where
-<product_script_name> - installation
-script name (described in configuration xml file);
-<function_name> - the name of
-function, corresponding to the selected installation mode: try_native,
-install_source, install_binary or try_preinstalled;
-<temp_folder> - temporary files
-directory;
-<products_directory> - directory
+
<product_script_name>
+-
+the name of the installation script (described in the configuration XML
+file);
+<function_name>
+- the name of
+the function, corresponding to the selected installation type and
+currently installed product;
+
+<temp_folder> - the directory for the
+temporary files;
+<products_directory>
+- the directory
where the sources/binaries package can be found. You should provide
sources package in the <Install_Wizard_root_directory>/Products/SOURCES
directory and binaries package in the <InstallWizard_root_directory>/Products/BINARIES/<os_version>,
-where <os_version> is target platform description, which appears
+where <os_version> is the target platform description,
+which appears
in the corresponding section of the configuration
xml
file.
-<target_directory> - root target
-directory where product should be installed to;
-<dependancies> - single-quoted list
-of prerequisite products, separated by space;
-<product_name> - product name
-itself.
+ +<all_products> - single-quoted list +of all products, separated by space;
+ +<product_name> - product name +itself;
+ +<install_products> - single-quoted list +of all products to be installed, separated by space;
+ +<sources_directory> - the directory +where the sources package can be found (it is usable if the +<products_directory> parameter gives the binaries +directory path);
+ +<remove_sources_flag> - bool parameter, that +is equal to 'TRUE' if 'Remove sources and temporary files after +compilation' option has been selected by the user (see Fig.2 in the GUI part);
+ +<binaries_directory> - the directory +where the binaries package can be found (it is usable if the +<products_directory> parameter gives the sources +directory path);
+ +<single_directory_flag> - bool parameter, +that is equal to 'TRUE' if 'Install modules to a single directory' +option is selected by the user (see Fig.5 +above).
+
Example:
-med-2.2.2.sh install_binary /tmp/work
-./Products/BINARIES/Mandrake10.1 /usr/salome 'gcc Hdf' med
Copy created script into the <Install_Wizard_root_directory>/config_files -sub-directory where all installation scripts are stored. Installation -Wizard -will automatically search and call your script during the installation +med.sh install_binary +/tmp/INSTALLWORK21797 +./Products/BINARIES/Mandriva2010.0 +'gcc tcltk tcltk_src Python Python_src Qt Qt_src ... DOCUMENTATION +DOCUMENTATION_src' +Med +'gcc Hdf Med' +./Products/SOURCES +FALSE +./Products/BINARIES/Mandriva2010.0 +
+Copy the created script +into +the <Install_Wizard_root_directory>/config_files +sub-directory where all installation scripts are stored. The Installation +Wizard will automatically search and call your script during the +installation procedure.
+
Customizing Readme +page buttons
+The Installation Wizard allows customizing the layout of the last +"Finish installation" page. If you want to add one +or more +buttons in this page to perform some specific actions at the +end of the installation (for example, show the 'Release Notes' file by using +Open Office) you can put an additional section to the XML +configuration file. This is the <button> +section (see here for more +details).+
+To implement the action which will be performed when the user clicks on +the button, you need to create a script and to put it into the +<Install_Wizard_root_directory>/config_files +directory.
+There are some obligatory functions which should be implemented in this +script. These functions are automatically called by the Installation +Wizard GUI. +
-
+
- check_enabled() +
-
+
- execute() +
+
+The calling signature of the script is the following:
+<product_script_name> +<function_name> <target_directory> +<temp_folder> +
where
+
<product_script_name>
+-
+the script name itself (retrieved from the XML configuration xml
+file);
+<function_name>
+- the name of the function;
+<target_directory>
+- the root target
+directory where the product is
+installed to;
+<temp_folder>
+ - the directory for the temporary files.
+
+Note: The standard Installation Wizard buttons
+"Launch
+SALOME" and "Release Notes" are implemented with this
+feature. Refer to the scripts start_salome.sh and
+release_notes.sh for the sample implementation.
-
+Note: Any button (even standard) can be ignored by
+the
+Installation Wizard if the attribute <disable>
+in the XML
+configuration file is set to the "true" value.
+
+