+
+
+
updated for the version 2.1.0
-
--
+
++
|
- 
- 
-
-
-
-|
- |
-
- |
-
- - of installation procedure |
-
- |
-
|---|---|---|---|
| gcc 3.2 | -ver=`/usr/bin/gcc --version | grep 'gcc (GCC) .*' | cut -b 11-13` | -
- |
- ver should be equal 3.2 - It is recommended to use native gcc on Linux RedHat 8.0 |
-
| tcl 8.3 | -existence of TCLHOME - existence of tclsh8.3 - existence of wish8.3 - existence of libtcl8.3.so - existence of libtk8.3.so - existence of libtclx8.3.so - existence of libtkx8.3.so |
- set TCLHOME if you have preinstalled version of tcl. - set LD_LIBRARY_PATH on a directory where libs can be found. |
- It is recommended to use native tcl on Linux RedHat 8.0 | -
| boost 1.30.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 - |
- It is impossible to use native BOOST and to install
-BOOST from binaries. - |
-
| Open CASCADE 5.2 - |
- existence of CASROOT environment variable | -set CASROOT if you have preinstalled version of Open CASCADE | -Unfortunately we can't say anything exactly about CASCADE 5.2 -and we only check CASROOT environment variable. If you have problem with -preinstalled version of Open CASCADE, reinstall it | -
| Patch for Open CASCADE 5.2 - |
- - | - | Open CASCADE 5.2 provided with the Installation Wizard already includes the patch, -necessary for PAL/SALOME 2.1.0. In addition the Installation Wizard provides the sources of a Open CASCADE patch -which can be applied to original Open CASCADE 5.2. sources before compilation. | -
| Python 2.2.1 | -existence of PYTHONHOME - isPython=`which python` - ver=`python -V` |
- set PYTHONHOME to root Python folder - set PATH on a directory where python can be found |
- Python should exist and ver should be equal to 2.2.1 - It is recommended to use native Python on Linux RedHat 8.0 |
-
| Mesa 3.4.2 | -existence of libGL.so.1.2.030402 | -set LD_LIBRARY_PATH on a directory where libGL.so.1.2.030402 -can be found | -You have a possibility to build products (vtk & qt) with -Mesa drivers from the package supplied with this installation procedure or -to use OpenGL drivers installed on your computer locally. This check procedure - concerns only supplied Mesa driver. | -
| Swig 1.3.17 | -isSwig=`which swig` - ver=`swig -version` - ver=`echo $ver | awk '{print $3}'` |
- set PATH on a directory where swig can be found | -Swig should exist and ver should be equal to 1.3.17 | -
| Qt 3.0.5 | -existence of QTDIR - existence of libqt-mt.so.3.0.5 |
- set QTDIR if you have preinstalled version of qt | -We try to find libqt-mt.so.3.0.5 in ${QTDIR}/lib folder. - You should set MESA_HOME only if you have preinstalled version of Mesa -3.4.2. - It is recommended to use native Qt on Linux RedHat 8.0 |
-
| Qwt 0.4.1 | -existence of QWTHOME - existence of libqwt.so.0.4.1 |
- set QWTHOME if you have preinstalled version of qwt | -We try to find libqwt.so.0.4.1 in the ${QWTHOME}/lib folder. | -
| Hdf 5-1.4.4 | -existence of HDF5HOME - existence of libhdf5.so.0.0.0 - existence of libhdf5.settings |
- 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 should contain the following entry: - HDF5 Version: 1.4.4 |
-
| Med 2.1.6 | -existence of MED2HOME - existence of libmed.so.0.0.0 |
- set MED2HOME if you have preinstalled version of med | -Unfortunately we can't check version number. - We try to find libmed.so.0.0.0 in ${MED2HOME}/lib folder. - If you have problem with preinstalled version of med reinstall it. |
-
| Vtk 4.2 | -existence of VTKHOME - existence of libvtkCommon.so |
- set VTKHOME if you have preinstalled version of vtk | -Unfortunately we can't check the 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 - |
- existence of NETGENROOT - |
- 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 3.0.5, - OmniORBpy 1.5, - OmniNotify 1.2 |
- existence of OMNIORBDIR - existence of libomniORB3.so.0.5 - existence of _omnipymodule.so.0.5 - existence of libCOSNotify3.so.0.5 - existence of notifd - existence of THIS_IS_omniORB_3_0_5 - existence of THIS_IS_omniNotify_1_2 - existence of THIS_IS_OMNIORBPY_1_5 |
- set OMNIORBDIR if you have preinstalled version of omni | -We try to find libomniORB3.so.0.5, _omnipymodule.so.0.5 and libCOSNotify3.so.0.5
- in ${OMNIORBDIR}/lib/i586_linux_2.0_glibc2.1 folder. - We try to find notifd in ${OMNIORBDIR}/bin/i586_linux_2.0_glibc2.1 folder. - - Additional checking - omni add special files THIS_IS_... - We try to find THIS_IS_omniORB_3_0_5 in ${OMNIORBDIR} folder. - We try to find THIS_IS_omniNotify_1_2 in ${OMNIORBDIR}/src/services/omniNotify. +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 the +terminal +window: + [ python ] ./runInstall [options] Without options this script will launch the SALOME Installation
+Wizard in the GUI mode. -g / --gui Runs the Installation Wizard in the
+GUI
+mode (this is the default mode).
++ -b / --batch Runs the Installation Wizard in
+the terminal mode.
++ -f FILE / --file=FILE
+This is the XML configuration file used by the Installation Wizard.
+If this option is not used, the installation script tries to define
+theLinux version and to use the corresponding XML file
+if it is present.
+For example, for Linux Mandriva
+2010 the config_Mandriva_2010.0.xml
+file
+will be used by default.
+
+ -d DIR / --target=DIR This is the target installation
+directory for SALOME platform. If used, this option overrides
+the default target directory, given in the
+configuration XML file (usually
+${HOME}/salome_<version>).
++ -t DIR / --tmp=DIR +This is the directory, for
+temporary files. If given, this option overrides the default
+temporary directory, given in the configuration xml file
+(usually /tmp
+).
++ -a / --all-from-sources +
+Force all the products to be installed from sources (including all
+SALOME modules). If this option is used, all the default installation
+modes for all the products are ignored.
++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 +Install all SALOME binaries packages
+to one directory.
++This option is ignored when --all-from-sources (-a) option is used. + -h / --help Prints help information on
+the usage of the Installation Wizard.
+
++
+-v / --version Prints version information
+(Note: this
+is the version number of the Installation Wizard, not of SALOME platform).
++ + +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. GUI
+mode
+ |
-
| Numeric 22.0 | -existence of Numeric folder - existence of _numpy.so |
- set PYTHONHOME if you have preinstalled version of python | -Unfortunately we can't check the version number. - We try to find Numeric folder in ${PYTHONHOME}/lib/python2.2/site-packages/Numeric - folder. - If you have problem with preinstalled version of numeric 22.0 reinstall -it. |
-
| Sip 3.3.2 | -existence of SIPDIR - existence of sip - existence of libsip.so.9.1.0 |
- set SIPDIR to directory where you have sip preinstalled | -We try to find sip and libsip.so.9.1.0 in $SIPDIR folder if you
-set SIPDIR , otherwise searching is done using $PATH and $LD_LIBRARY_PATH
- accordingly. - It is recommended to use native Sip on Linux RedHat 8.0 |
-
| PyQt 3.3.2 | -existence of PYQTDIR - existence of libqtxmlcmodule.so.1.0.0 |
- set PYQTDIR to directory where you have sip preinstalled | -Unfortunately we can't check the version number. - We try to find libqtxmlcmodule.so.1.0.0 in $PYQTDIR folder if you set PYQTDIR, -otherwise searching is done using $LD_LIBRARY_PATH . - If you have problem with preinstalled version of PyQt 3.3.2 reinstall it. + + + +
- It is recommended to use native PyQt on Linux RedHat 8.0 |
-
| HappyDoc 2.1 | -existence of happydoc - ver=`happydoc | grep "HappyDoc version 2.1"` |
- set PYTHONHOME if you have preinstalled version of python | -We try to find happydoc in $PYTHONHOME/bin folder. - ver should not be empty. - This product is not obligatory. It was added only for your comfort. |
-
| Doxygen 1.3-rc2 | -existence of doxygen - existence of doxysearch - existence of doxytag - existence of doxywizard |
- set QTDIR if you have preinstalled version of qt - set PATH on a directory where doxygen, doxysearch, doxytag and doxywizard - can be found |
- Unfortunately we can't check the version number. - It's necessary to have compiled Qt in order to build doxywizard. - If you have problem with preinstalled version of doxygen 1.3-rc2 reinstall - it. - This product is not obligatory. It was added only for your comfort. |
-
| Graphviz 1.9 | -existence of dot | -add GraphViz's bin directory to the PATH environment variable | -Unfortunately we can't check the version number. - We try to find dot program in the $PATH |
-
| MODULE binaries - (MODULE=KERNEL,GEOM, ...) - |
- existence of MODULE_ROOT_DIR - existence of VERSION file - ver=`cat $MODULE_ROOT_DIR/bin/salome/VERSION | awk -F: '{print $2}' | tr --d '[:space:]'` |
- set MODULE_ROOT_DIR if you have preinstalled binaries of MODULE - version 2.1.0 | -MODULE binaries should exist and ver should be equal to 2.1.0 | -
| MODULE sources - (MODULE=KERNEL,GEOM, ...) - |
- existence of MODULE_SRC_DIR - existence of VERSION file - ver=`cat $MODULE_SRC/bin/VERSION | awk -F: '{print $2}' | tr -d '[:space:]'` |
- set MODULE_SRC_DIR if you have preinstalled sources of MODULE -version 2.1.0 | -MODULE sources should exist and ver should be equal to 2.1.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.
-
-
+
+
+ +
-
+
- 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: +
+-
+
- 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 +
+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 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 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 +
+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 +
++
+
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
+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 the procedure of launching SALOME. These
+shell scripts set
+all necessary environment variables for all products you have
+installed.
+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 and env_build.csh
++ env_build.sh
+in the
+target installation directory.
+
+
+
Pick up the environment
- Please, read carefully the following information. This section describes - how the installation procedure collects environment. -After installing each product shell script creates in the product root - folder special environment file. 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. 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 find 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 (gcc, tcl, python, qt, sip, pyqt for RedHat-8.0)
-instal script tries to find them 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.
- --
Modifying XML configuration - file
- You can create your own configuration. 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 ar given, is config.xml. -This section describes the format of configuration file.- Xml tags are in bold blue, optional sections/tags -are in brackets. -
<document>
- [<config [version=<install_wizard_version>]
-
-
- [caption=<install_wizard_caption>]
-
- [copyright=<install_wizard_copyright>]
-
- [license=<install_wizard_license_info>]
-
- [os=<target_paltform>]/>]
- [<path [targetdir=<target_directory>]
-
-
- [tempdir=<temp_directory>]/>]
- [<product name=<product_name>
-
-
- version=<product_version>
-
- [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>
-
- temporarydiskspace=<tmp_disk_space>
-
- script=<installation_script_name>/>]
- [<product ... />]
- ...
+Please, read carefully the following information. This section
+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. 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 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 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>
+
+
+
+<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> ]
-</document>
<config> section
- This is optional section - contains general information - Installation Wizard itself. --
-
- 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. - -
<path> section
- This is optional section - contains default directories. --
-
- 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. - -
+ +[ <buttons> +
+ +[ <button + +label=<button_label> +
+ + +[ tooltip=<button_tooltip> ]
+ + + +script=<button_script> +
+ + +[ disable=<disable_flag> ]
+ /> +
+ ]
+ +[ +<button +...
+ /> +
+ +]
+ +... +
+ </buttons> +
+ ]
+ [ <products> +
+ +[ +<product +name=<product_name>
+ + + +type=<product_type>
+ + [ +description=<product_description> ]
+ + +<installation +os=<installation_platform>
+ + + + +version=<product_version>
+ + + + [ +disable=<disable_flag> + ] +
+ + + [ +woguimode=<without_gui_mode_flag> ] +
+ + +installdiskspace=<install_disk_space>
+ + + [ +pickupenv=<pickup_env_flag> + ] +
+ + + + +script=<installation_script_name>
+ +/>
+ +... +
+ /> +
+ ]
+ [ <product ...
+ />
+ ]
+ +...
+ </products> +
+ ]
+ [ <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 +
-
+
- copyright +
-
+
- 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. - All tags are obligatory. Products appears 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. - --
-
- name: Name of the product; -
- version: Version of the product; -
- description:
- Description of the product (optional);
-
- - 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. 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. - -
+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 +
-
+
- 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 -script. These functions are automatically called by master installation script -or/and GUI shell when it is necessary.
-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 -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 internal -function and is not called -
- 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 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 -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 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 -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 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 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 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 tag
-of the configuration xml file (see previous section). Should call make_env
-procedure to perform pick-up environment procedure for the product.
-
-
+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 the installation script,
+following
+rules described in this section. - check_version() +
- install_binary() +
- install_source() +
- install_source_and_build()
- try_preinstalled() +
- print_env_bin() + & print_env_src() +
- pickup_env() +
- check_enabled() +
- execute() +
+
+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 +functions +which can be used in your installation script, like make_env(), +make_dir(), try_existing(), sort_path(), +find_in_path(), +etc. +
-
+
+
-
+
+ +
-
+
+
-
+
- <product_script_name> <function_name> - <temp_folder> <products_directory> <target_directory> -<dependancies> <product_name> +This function is +called when 'Install sources and make a compilation' +installation mode is selected. This function should be used to unpack +SALOME or prerequisite sources package and then call build/install +procedure for it.
+For more details please refer to this +section for more details.
+ +
-
+
-
+
-
+
+
+The calling signature of the product +installation +script is the following:
+ +<product_script_name> +<function_name> +<temp_folder> +<products_directory> +<target_directory> +<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 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 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.
-
<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 the target platform description,
+which appears
+in the corresponding section of the configuration
+xml
+file.
+
+<target_directory> - the root target
+directory where the product should be installed to;
+
+<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.1.6.sh install_binary /tmp/work ./Products/BINARIES/RedHat8.0
- /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 procedure. -
- +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. +
-
+
-
+
+
+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.
+
+