From: vsr Date: Mon, 22 Jan 2007 13:56:33 +0000 (+0000) Subject: Update GUI documentation: SALOME installation page X-Git-Tag: V3_2_5pre1~8 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=31a4f168702a093af62762d34152072d05ba8783;p=modules%2Fgui.git Update GUI documentation: SALOME installation page --- diff --git a/doc/salome/gui/GUI/kernel.log b/doc/salome/gui/GUI/kernel.log index a22dc0334..25f6e5930 100755 --- a/doc/salome/gui/GUI/kernel.log +++ b/doc/salome/gui/GUI/kernel.log @@ -54,22 +54,6 @@ whdata\whfwdata.js whres.xml webhelp.jar webhelp.cab -whgdata\whnvp30.htm -whgdata\whnvp31.htm -whgdata\whnvp32.htm -whgdata\whnvp33.htm -whgdata\whnvt30.htm -whgdata\whnvt31.htm -whgdata\whnvt32.htm -whgdata\whnvt33.htm -whgdata\whnvf30.htm -whgdata\whnvf31.htm -whgdata\whnvf32.htm -whgdata\whnvf33.htm -whgdata\whnvl31.htm -whgdata\whnvl32.htm -whgdata\whnvl33.htm -whgdata\whexpbar.gif cshdat_webhelp.htm whcsh_home.htm whcshdata.htm @@ -147,65 +131,72 @@ robohhre.lng texture_horiz_ltbluebubbles.jpg index.glo default.css +kernel\progresspage.png +pics\ppref1.png +pics\geomview-alt.png pics\registry1.png pics\open.jpg -pics\icon_about.png -pics\registry3.png -pics\studyproperties.png -pics\readmepage.png -pics\registry4.png -pics\cataloggenerator.png -tip1.gif +pics\ppref2.png pics\pref31.png -pics\save.jpg -pics\pref32.png +kernel\batchmode.png +kernel\choicepage.png +kernel\logocorp.png +pics\ppref3.png pics\pref21.png -image70.gif -pics\newsticn.jpg +pics\view2.png +pics\registry3.png +pics\studyproperties.png +closestudy.png +pics\copy-paste.jpg +kernel\productpage.png pics\pref33.png pics\pref22.png pics\pref11.png -image71.gif +pics\registry4.png +note1.gif pics\pref34.png pics\pref23.png pics\pref12.png -image94.gif -closestudy.png -image72.gif -pics\copy-paste.jpg +pics\selectfont.png +image70.gif pics\pref24.png pics\pref13.png -pics\selectfont.png -pics\view2.png -image54.jpg -image73.gif -pics\selectcolor.png -pics\exemple.gif +image71.gif +pics\save.jpg +kernel\productpage1.png pics\pref14.png -pics\dumpstudy.png -pics\neo-view2.png +image94.gif +image72.gif +pics\selectcolor.png +pics\newsticn.jpg +kernel\readmepage.png +kernel\progresspage1.png +kernel\productpage2.png +kernel\intropage.png pics\pref37.png pics\pref15.png -image75.gif -i_blue.jpg -pics\productpage.png +pics\cataloggenerator.png +image54.jpg +image73.gif pics\pref38.png -image65.gif -note1.gif -pics\intropage.png -pics\pref39.png pics\import.png -pics\objectbrowser1.png -pics\progresspage.png -pics\objectbrowser2.png -image67.gif +pics\pref39.png pics\loadscript.png -pics\geomview-alt.png -pics\lockedstudy.png pics\loadstudy2.png +image75.gif +pics\dumpstudy.png +pics\neo-view2.png +image65.gif +pics\lockedstudy.png +image67.gif +pics\objectbrowser1.png image68.gif -pics\choicepage.png +tip1.gif +i_blue.jpg +pics\objectbrowser2.png image69.gif +kernel\application.png +pics\icon_about.png index.ppf ehlpdhtm.js ss_btn_related_topics.gif @@ -218,53 +209,6 @@ whdata\whtdata0.htm whdata\whftdata0.htm whdata\whfwdata0.htm whdata\whgdata0.htm -whgdata\whlstt0.htm -whgdata\whlstt1.htm -whgdata\whlstt2.htm -whgdata\whlstt3.htm -whgdata\whlstt4.htm -whgdata\whlstt5.htm -whgdata\whlsti0.htm -whgdata\whlstfl0.htm -whgdata\whlstfl1.htm -whgdata\whlstfl2.htm -whgdata\whlstfl3.htm -whgdata\whlstfl4.htm -whgdata\whlstfl5.htm -whgdata\whlstfl6.htm -whgdata\whlstfl7.htm -whgdata\whlstfl8.htm -whgdata\whlstfl9.htm -whgdata\whlstfl10.htm -whgdata\whlstfl11.htm -whgdata\whlstfl12.htm -whgdata\whlstfl13.htm -whgdata\whlstfl14.htm -whgdata\whlstfl15.htm -whgdata\whlstfl16.htm -whgdata\whlstfl17.htm -whgdata\whlstfl18.htm -whgdata\whlstfl19.htm -whgdata\whlstfl20.htm -whgdata\whlstfl21.htm -whgdata\whlstfl22.htm -whgdata\whlstfl23.htm -whgdata\whlstfl24.htm -whgdata\whlstfl25.htm -whgdata\whlstfl26.htm -whgdata\whlstf0.htm -whgdata\whlstf1.htm -whgdata\whlstf2.htm -whgdata\whlstf3.htm -whgdata\whlstf4.htm -whgdata\whlstf5.htm -whgdata\whlstf6.htm -whgdata\whlstf7.htm -whgdata\whlstf8.htm -whgdata\whlstf9.htm -whgdata\whlstf10.htm -whgdata\whlstf11.htm -whgdata\whlstg0.htm index.htm index_csh.htm index_rhc.htm diff --git a/doc/salome/gui/GUI/kernel/application.png b/doc/salome/gui/GUI/kernel/application.png new file mode 100644 index 000000000..c9fd6fd4a Binary files /dev/null and b/doc/salome/gui/GUI/kernel/application.png differ diff --git a/doc/salome/gui/GUI/kernel/batchmode.png b/doc/salome/gui/GUI/kernel/batchmode.png new file mode 100644 index 000000000..c439d7ebb Binary files /dev/null and b/doc/salome/gui/GUI/kernel/batchmode.png differ diff --git a/doc/salome/gui/GUI/kernel/choicepage.png b/doc/salome/gui/GUI/kernel/choicepage.png new file mode 100644 index 000000000..e3afcc588 Binary files /dev/null and b/doc/salome/gui/GUI/kernel/choicepage.png differ diff --git a/doc/salome/gui/GUI/kernel/introduction.bak b/doc/salome/gui/GUI/kernel/introduction.bak new file mode 100644 index 000000000..7fe0eb4d9 --- /dev/null +++ b/doc/salome/gui/GUI/kernel/introduction.bak @@ -0,0 +1,2088 @@ + + + + + + + + + + +SALOME Installation Wizard Help + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

 

+ + + + + + + + +
+

+		 +

SALOME Installation Wizard + Help

+		 +
+ +
+ +
+  +
+ + + +
+ + + + + + +
+ + +

Installing products with the Installation Wizard

+ +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 default mode (GUI).
+The default installation settings can be overridden by using command line + options. Each option has a short and a long notation:

+ +

-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

+ +
+The XML configuration file to be used by the Installation Wizard.  + If this option is not used then the installation script tries to define + the Linux version and use the corresponding XML file if it exists. + For examle, for Linux Mandrake + 10.1  the config_Mandrake_10.1.xml  file + will be used by default. If no appropriate file is found, the file config.xml + will be used. This file refers to the basic target platform which is Linux Mandrake 10.1 for SALOME + 3.0 and newer. If config.xml + file is not found either, a warning message box is shown (in GUI mode) + or printed to the console (in batch mode) and the Installation Wizard + quits. +
+ +

-d DIR / --target=DIR

+ +
+The target directory SALOME platform is to be installed to. If used, + this option overrides the default target directory, given in the configuration + XML file (usually ${HOME}/salome_<version>, + see here for more details). +
+ +

-t DIR / --tmp=DIR

+ +
+The directory, which should be used for temporary files. If given, + this option overrides the default temporary directory, given in the configuration + xml file (usually /tmp, + see here for more information). +
+ +

-a / --all-from-sources

+ +
+Forces all the products to be installed from sources (including all + SALOME modules). If this option is used, all default installation modes + for all 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 a time-consuming operation which can take more than + 24 hours depending on the computer. +
+ +

-h / --help

+ +
+Prints help information on the Installation Wizard's use. +
+ +

-v / --version

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

The installation procedure supports different Linux + platforms and installs various installation 3d-party prerequisite + products which are required by SALOME platform. As it was mentioned above, + the basic target platform for SALOME 3.0 and newer is Linux + Mandrake 10.1.
+Use of configuration XML files gives a flexible way to modify the list + of products to be installed by the Installation Wizard without changing + the program source code. 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 Installation Wizard GUI has been developed + using Trolltech's Qt + 3.0.5 toolkit. 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. + The "Cancel" button closes the wizard window and + quits the installation procedure after the user's confirmation. The "Help" + button opens an additional window to show help information.

+ +

The first "Introduction" + page is shown in Figure 1. Skip this page by + clicking "Next":

+ + + +

 

+ +

Intro page

+ +

Figure 1: "Introduction" + page

+ +

In the second page you are proposed to enter the target directory where + the SALOME platform should be installed to. You can also click "Browse..." + and choose the destination folder using the standard browse directory + dialog box.
+If the directory you want to install products to does not exist you are + prompted to confirm directory creation. If you type a wrong directory + path, or if you do not have write permissions for the directory you use, + the corresponding message box is shown.

+ +

You can also change the temporary directory (which is used to store + temporary files required for the installation).
+In the bottom part of the window the total disk space required for the + installation and for the temporary files is displayed (see below for more + details).

+ +

In the GUI mode the Installation Wizard provides two different options + to install the SALOME platform: basic + (default option) and advanced. + In the basic mode the user should + enter the target installation directory and temporary folder. All other + installation options are taken from the XML configuration file (see Fig.2):

+ + + +

 

+ +

Intro page

+ +

Figure 2: "Installation + settings"

+ +

In addition, you have a choice to use "Install all products from + sources" check box. If this option is turned on, all the products + will be installed from the sources (using their own build procedures). + This check box corresponds to the --all-from-sources + (-a) option of the runInstall + script (see here).

+ +

Installation of all products + from sources is a long-time operation.

+ +

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

+ +

In the advanced mode you have a possibility to select products to be + installed. Each product can have several options of installation: you + have a possibility to use the native product (provided with Linux distribution + and installed in the system folders), install already precompiled binaries, + build the product from sources or not install it at all. Available options + and default option are taken from the XML configuration file. You can + mark the products you want to install by clicking the corresponding radio-buttons + in the list view in the left part of the page.
+Note, that some products may require some other pre-requisite products + to be installed (or these prerequisite products should be already available + 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 is necessary to have gcc, Python, + Qt and Sip installed. Therefore all these products + will also be  turned + on when you check on PyQt. This feature can be switched + off by clicking the "Automatic dependencies" checkbox. + Turn on this checkbox if you want all prerequisite products to be automatically + checked when you select some product to be installed. Turn off this checkbox + if you want to disable this feature.

+ + + +

 

+ +

Products page

+ +

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

+ +

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

+ +

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

+ +

In addition, when some SALOME sources are selected, one more check box + becomes available: "Build SALOME + sources". If this option is turned on, the selected SALOME + modules will be built and installed from sources.
+ 

+ +

If this check box is turned on, + the corresponding SALOME module binaries package installation is disabled, + because of  SALOME + module sources and binaries packages conflict (see Fig. + 4 below).

+ + + +

Products page

+ +

Figure 4: "Build + SALOME sources" check box usage

+ +

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

+ +The "Disk space required:" field displays how much disk + space on the hard drive is required for installation of selected products. + + +

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

+ +

The installation procedure uses a special directory to store temporary + files. The "Space for temporary files:" field shows the + information about required disk space on the hard drive for extracting + and compiling the selected products. You can change the temporary directory + - just type a path to the folder you want to use or click on the corresponding + "Browse..." button.
+ 

+ +

Actually, + temporary files are not stored directly in the directory entered by the + user. The Installation Wizard creates an additional folder in this directory + named something like INSTALLWORKXXXXX + where XXXXX is a unique number. This allows to launch 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 a corresponding + error message box.

+ +

You are strongly recommended not + to use directory names containing spaces. Otherwise you can experience + some troubles with the installation.

+ +

To proceed further click "Next". At this moment the + program will make some tests to check installation settings: if there + is enough disk space on the hard drive, check for native products installation, + dependencies (prerequisites) for each product you have selected to be + installed. If any test fails you will see the corresponding warning message + box. Otherwise the wizard will proceed to the next page:

+ + + +

 

+ +

Choice page

+ +

Figure 5: "Check + your choice" page

+ +

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

+ + + +

 

+ +

Progress page

+ +

Figure 6: "Installation + progress" page

+ +

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

+ +

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

+ +

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

+ + + +

 

+ +

Progress page

+ +

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

+ +

The "Installation Status" frame window shows you the + progress of installation. "Waiting" + status means that installation of this product has not been started yet. + The product currently being installed is marked as "Processing". All installed products have + "Completed" status.

+ +

You can abort installation and close the installation procedure using + "Cancel" button.

+ +  + +

This button sends the signal "SIGTERM" to the + shell script. The script tries 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" to go the Readme page:

+ + + +

 

+ +

Read page

+ +

Figure 8: "Finish + installation" page

+ +

In this page you can read important information about the Instalation + Wizard itself and some tips: how to run and test SALOME or how to build + SALOME from the sources. This is the contents of the README file which + you can find in the root directory of the Installation Wizard.
+You can also launch SALOME Desktop from this page 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 the user does + 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.
+The only exception is --all-from-sources + (-a) option which enables special + installation mode in which all the products (including SALOME modules) + are installed from sources, ignoring the default mode defined in the XML + configuration file (see here for details).

+ +

 
+
+Batch mode

+ +

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 installation scripts collects 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.

+ +

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

+ + 
+ + + +
+ + +

Notes on check products + version procedure

+ +Unfortunately there is no exact algorithm to identify the product version + under Linux platform. The information in this section gives an idea how + the version is checked for the native/preinstalled products (this information + refers to the base platform Linux + Mandrake 10.1; and the same algorithms are used for other platforms). +
+The general rule for all products is that the path to the binaries should + be set via the PATH environment + variable, path to the libraries should be set via the LD_LIBRARY_PATH + variable and the python modules should be available via the PYTHONPATH + variable. + +

Note: the information + given in this section refers to the prerequisite products for SALOME version + 3.2.4.

+ + + +Version number is checked by gcc -dumpversion + command. The gcc executable should + be in the PATH environment variable. + Version should be equal to "3.4.1". It is recommended to use + native gcc on Mandrake 10.1. + + + +Version number for tcl/tk can be + found in tclConfig.sh and tkConfig.sh files (TCL_VERSION + and TK_VERSION variables correspondingly). + Version number should be equal to "8.4" (release number is not + checked).
+Set the TCLHOME environment variable + to the root directory of tcl/tk installation.
+It is recommended to use native tcl/tk on Mandrake 10.1. + + + +Version number is defined by version.hpp + file which is part of the boost distribution. This file defines the BOOST_VERSION macro which should be + equal to "103100". In addition the existence of boost libraries + is checked.
+Set the BOOSTDIR environment variable + if you have a preinstalled version of boost. + + + +Version number is checked by python -V + command. The python executable + should be in the PATH environment + variable. Version number should be equal to "2.3.4". It is recommended + to use native Python on Mandrake 10.1.
+Set the PYTHONHOME environment + variable if you have a preinstalled version of Python. + + + +Version number is checked by swig -version + command. The swig executable should + be in the PATH environment variable. + Version number should be equal to "1.3.24". + + + +Version number is defined by qglobal.h + file which is part of the Qt distribution. This file defines QT_VERSION_STR + macro which should be equal to "3.3.3". It is recommended to + use native Qt on Mandrake 10.1.
+Set the QTDIR environment variable + if you have a preinstalled version of qt. + + + +msg2qm is a Qt tool which is used + to convert text *.po files to *.qm resource files. Unfortunately this + tool is not included to the Linux distribution and provided only in Qt + sources package. This is the reason why this tool is supplied with the + SALOME Installation Wizard.
+There is no way to check the version number of msg2qm tool. Just set MSG2QM_ROOT environment variable if + you have a preinstalled version of msg2qm tool. + + + +Version number is defined by Standard_Version.hxx + file which is part of the Open CASCADE distribution. This file defines + OCC_VERSION_MAJOR, OCC_VERSION_MINOR + and OCC_VERSION_MAINTENANCE macros + which should refer to version 6.1.2.
+Set the CASROOT environment variable + if you have a preinstalled version of Open CASCADE. + + + +Version number is defined by qwt_global.h + file which is part of the qwt distribution. This file defines QWT_VERSION_STR + macro which should be equal to "4.2.0".
+Set the QWTHOME environment variable + if you have a preinstalled version of qwt. + + + +Version number is defined by libhdf5.settings + file which is part of the hdf5 + distribution. Version should be equal to 1.6.4.
+Set the HDF5HOME environment variable + if you have a preinstalled version of hdf5. + + + +Unfortunately there is no formal way to check med version number. We check + existence of libmed.so.1.0.2 library on the computer. If you have any + problem with a preinstalled version of med, please, reinstall it.
+Set the MED2HOME environment variable + if you have a preinstalled version of med. + + + +Unfortunately there is no formal way to check VTK version number. We just + check the existence of libvtkCommon.so + library on the computer and hope that it is of version we need. If you + have any problem with a preinstalled version of Vtk, please, reinstall + it.
+Set the VTKHOME environment variable + if you have a preinstalled version of Vtk. + + + +We just check existence of some omniORB libraries and executable on the + computer, like libomniORB4.so.0.5, + _omnipymodule.so.2.4, libCOSNotify4.so.0.1 + and notifd.
+Set the OMNIORBDIR environment + variable if you have a preinstalled version of omniORB products. + + + +Version number is checked by sip -V + command. The sip executable should + be in the PATH environment variable. + Version number should be equal to "4.1".
+Set the SIPDIR environment variable + to the directory where you have sip executable preinstalled. + + + +Version number is defined by pyqtconfig.py + Python module file which is part of the PyQt + distribution. Version should be equal to "3.13".
+Set the PYQTDIR environment variable + if you have a preinstalled version of PyQt. + + + +Unfortunarely we can't find anything about netgen version. We just check + if NETGENROOT environment variable + is set.
+Set the NETGENROOT environment + variable if you have a preinstalled version of netgen mesher. + +
  + + +

Note: netgen 4.5 provided with the SALOME installation + Wizard has been patched to improve its performance.

+ + + +Version number is checked by python -c + 'import Numeric; print Numeric.__version__' command. The python executable should be in the PATH environment variable and Numeric module should be available for + the Python (for example it should be in the PYTHONPATH + environment variable). Version number should be equal to "23.7". + If you have any problem with a preinstalled version of Numeric 23.7, please, + reinstall it.
+Add the directory where you have a preinstalled version of Numeric + package to the the PYTHONHOME environment + variable. + + + +Version number is checked by dot -V + command. The dot executable should + be in the PATH environment variable. + Version number should be equal to "2.2.1".
+Add graphviz bin directory to the + the PATH environment variable. + + + + +Version number is checked by doxygen --version + command. The doxygen executable + should be in the PATH environment + variable. Version number should be equal to "1.4.6". + + + +For each SALOME module sources package (KERNEL, GUI, GEOM, etc...) the + root directory contains file configure.in (configure.ac) which defines + version information.
+Set the <MODULE>_SRC_DIR + environment variable for each SALOME MODULE + sources package installed (where MODULE + is KERNEL, GUI, GEOM, ...). + + + +For each SALOME module binaries package (KERNEL, GUI, GEOM, etc...) the + bin/salome directory contains + file VERSION which defines version + information.
+Set <MODULE>_ROOT_DIR environment + variable for each SALOME MODULE + binaries package installed (where MODULE + is KERNEL, GUI, GEOM, ...). + +

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

+ +

Note: for some native + products (e.g. gcc, Python) the rules of version checking are not so strict + as described above. Only major and minor version numbers should coincide + with the prerequisite. Newer version of the product can also be used. + If some native product has version number larger than that required by + the installation procedure, the 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 click "Yes" + to proceed with the installation but in this case you should be aware + of what you are doing. SALOME binaries (including other products) are + compiled with the predefined prerequisites and most likely can not be + run successfully if these products are not found. This can be helpful + only if you plan to build all products from sources.

+ + + +
+ + +

Pick up the environment

+ +Please, read the following information carefully . This section describes + how the installation procedure generates the environment scripts for the + SALOME platform being installed. + +

After installing each product shell the script creates a special environment + file for the product in its installation folder. The name of the file + is generated from the name of product by the following scheme: env_<product_name>.sh + (for example env_Vtk.sh for the Vtk). This file includes all necessary + environment settings. At the final step of the installation the script + picks up all the settings files and generates two common environment files + from them: salome.sh and salome.csh for bash + and csh shells correspondingly. + Such approach helps to save time when reinstalling products and you may + not bother about setting all environment variables manually to build/launch + SALOME. What you simply need is to source one of these environment files. +

+ +

This also concerns those 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 environment files from the target directory if it finds + necessary products installed there. If some product is not found in the + target directory the corresponding section of salome.sh/salome.csh + files will be skipped.
+For native products (like gcc, tcl, etc...) 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 the installation + procedure finishes, if you want.

+ +  + +

Note: + as it was mentioned above there are other environment + files which are 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 then 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. 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.
+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_platform> ]
+      />
+    ]
+    [ <path   [ targetdir=<target_directory> ] +
+              [ + tempdir=<temp_directory>     ]
+      />
+    ]
+    [ <button   label=<button_label>      +
+              + [ tooltip=<button_tooltip> ]
+              +   script=<button_script>   
+              + [ disable=<disable_flag>   ]
+      />
+    ]
+    [ <button ...
+      />
+    ]
+    [ <product  name=<product_name>
+                + version=<product_version>
+              [ context=<product_context>         + ]
+              [ 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 ...
+      /> +
+    ]
+    ...
+</document>

+ +

<config> section

+ +This is an optional section; it provides general + information about the Installation Wizard itself.
+
+Attributes: + + + +The application version number to be shown in the + caption. + + + +The application main window caption - if this string contains '%1' text + the title will contain the version number in this place (see above). + + + +The application copyright information (shown in the + first page). + + + +The application license information (shown in the + first page). + + + +This parameter defines the directory (relative from + ./Products/BINARIES) where the Installation Wizard will search precompiled + binaries packages. If this tag is not provided, binaries packages are + looked for in the ./Products/BINARIES directory. + +

<path> section

+ +This is an optional section; it defines default installation directories.
+
+Attributes: + + + +The target directory - the path to the directory + where products should be installed. + + + +The temporary directory - the path to the directory + for the temporary files. + +

<product> section

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

<button> section

+ +This is an optional section. It allows customization of the last "Finish + installation" page of the Installation Wizard by adding one or + more buttons in the lower part of the wizard's window. The script which + is attached to each such button, can perform some specific action, 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: + + + +This is the button text. + + + +The button tooltip (optional). + + + +The script attached to the button. + + + +

If this optional flag has 'true' + value, the corresponding button will not appear in the "Finish + installation" page - the section of XML file is silently ignored. 

+ +

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 its description to the configuration + file and create the installation script, following the rules described + in this section.
+
+There are some obligatory functions which should be implemented in this + installation script. These functions are automatically called by the 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. + + + + +This function allows to check the version of the product already installed + on the computer. It should try to find the product (native or preinstalled + in the target directory) and check its version. This helps to avoid unnecessary + reinstallation. This is an internal function and is not called from the + master installation script. + + + +This function is called when the 'use native' installation mode + is selected by the user. The function should try to find a native version + of the product and define possibility of its use. It should create the + environment file 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 native mode installation. + + + +This function is called when the 'install sources' installation + mode is selected by the user. The function is responsible for building + the product from the sources package. It should create the environment + file for the product in the temporary directory (see also description + of print_env() function). + It is not necessary to implement this function if you do not provide sources + mode installation. + + + +This function is called when SALOME module is installed + and the --all-from-sources (-a) option is used ("Build + SALOME sources" check box in GUI mode). This function should + be used to unpack SALOME sources package and then call the build/install + procedure for it.
+For more details please refer to the this + and this sections for more details. + + + +This function is called when the '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 + description of print_env() function). It is not necessary to implement + this function if you do not provide binaries mode installation. + + + +This function is called when the + 'not install' installation mode is selected by the user. In this case + the script should inspect the target directory to try to find an already + preinstalled product, pick up and check the environment from there. See + here for more details. + + + +This function is in charge of creating the environment + script. It should create a 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. + + + +This procedure corresponds to the pickupenv tag of the configuration + xml file (see previous section). It should call the make_env procedure + to perform the pick-up environment procedure for the product.
+
+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> + + +

where

+ +

<product_script_name> + - installation script name (described in the 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 the 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> - root target directory where the product + should be installed to;
+<dependancies> - single-quoted list of prerequisite products, + separated by space;
+<product_name> - product name itself.

+ +

Example:
+med-2.2.3.sh install_binary /tmp/work ./Products/BINARIES/Mandrake10.1 + /usr/salome 'gcc Hdf' med

+ +

Copy the 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.

+ + + +
+ + +  + +

Customizing Readme page + buttons

+ +The Installation Wizard allows customizing the look-n-feel of the last + "Finish installation" page. If you want to add one or + more buttons to this page in order to perform some specific actions at + the end of the installation (for example, to 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 the + button, you need to create a script and put it to 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. + + + +This procedure is called by the Installation Wizard when the "Finish + installation" page is displayed and the status of the buttons + should be modified according to the installation options. This procedure + should return 0 if the corresponding action can be performed and, + thus, the button should become enabled. Otherwise, it should return 1 + - in this case the corresponding button will be disabled. + + + +This procedure is invoked when the user clicks the button. This procedure + should return 0 if the corresponding action is done successfully + and 1 if any error occurs.
+
+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 function;
+<target_directory> - root target directory where the product + is installed to;
+<temp_folder> - temporary files directory;
+ 

+ +

Note: The standard + Installation Wizard buttons "Launch SALOME" and "Release + Notes" are implemented with this feature. Refer to scripts start_salome.sh + and release_notes.sh for 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.

+ + + +
+ + +  + + + + diff --git a/doc/salome/gui/GUI/kernel/intropage.png b/doc/salome/gui/GUI/kernel/intropage.png new file mode 100644 index 000000000..226793ca5 Binary files /dev/null and b/doc/salome/gui/GUI/kernel/intropage.png differ diff --git a/doc/salome/gui/GUI/kernel/logocorp.png b/doc/salome/gui/GUI/kernel/logocorp.png new file mode 100644 index 000000000..ab3c370a6 Binary files /dev/null and b/doc/salome/gui/GUI/kernel/logocorp.png differ diff --git a/doc/salome/gui/GUI/kernel/productpage.png b/doc/salome/gui/GUI/kernel/productpage.png new file mode 100644 index 000000000..bc05c8bfa Binary files /dev/null and b/doc/salome/gui/GUI/kernel/productpage.png differ diff --git a/doc/salome/gui/GUI/kernel/productpage1.png b/doc/salome/gui/GUI/kernel/productpage1.png new file mode 100644 index 000000000..b66616681 Binary files /dev/null and b/doc/salome/gui/GUI/kernel/productpage1.png differ diff --git a/doc/salome/gui/GUI/kernel/productpage2.png b/doc/salome/gui/GUI/kernel/productpage2.png new file mode 100644 index 000000000..998d286e3 Binary files /dev/null and b/doc/salome/gui/GUI/kernel/productpage2.png differ diff --git a/doc/salome/gui/GUI/kernel/progresspage.png b/doc/salome/gui/GUI/kernel/progresspage.png new file mode 100644 index 000000000..0779fccaf Binary files /dev/null and b/doc/salome/gui/GUI/kernel/progresspage.png differ diff --git a/doc/salome/gui/GUI/kernel/progresspage1.png b/doc/salome/gui/GUI/kernel/progresspage1.png new file mode 100644 index 000000000..efaa4d1ea Binary files /dev/null and b/doc/salome/gui/GUI/kernel/progresspage1.png differ diff --git a/doc/salome/gui/GUI/kernel/readme.html b/doc/salome/gui/GUI/kernel/readme.html index 2f9ad432d..0b4411a6c 100755 --- a/doc/salome/gui/GUI/kernel/readme.html +++ b/doc/salome/gui/GUI/kernel/readme.html @@ -3,58 +3,36 @@ -Installation Wizard +SALOME Installation Wizard Help - - - - -

Installing SALOME

+

 

+ + + + + + + +
+

 +

SALOME Installation Wizard + Help

 +
+ +
+
+  +
-
+ +
-
+

Installing products with the Installation Wizard

-

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 [<options>]. -  Each - option has short and long notation:

- -

 

- - - --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

-g  / -  --gui

-

Runs the Installation Wizard in the GUI mode (default option). In this - case only <xml-file> key - is taken into account. Other parameters are ignored.  

-

-b  / -  --batch -

-

Runs the Installation Wizard in command-line mode.

-

-f  <FILE> /  --file=<FILE> -

-

The configuration file to be used by the Installation Wizard.  - If this parameter is not used then the installation script tries to define - the Linux version and - use the corresponding xml file. For example, config_Mandrake10_1.xml  - file is to be used for  Linux - Mandrake 10.1. If the appropriate file is not found, the file config.xml - will be used.  This file refers to the basic target platform which - is Linux Mandrake 10.1 for SALOME 3.0 and higher. If config.xml file is - also not found, the warning message box is shown (in GUI mode) or printed - to the console (in batch mode) and the Installation Wizard quits.

-

-d <DIR> / --target=<DIR> -

-

The target directory for SALOME platform to be installed to. If used, -  this option - overrides the default target directory, defined in the configuration XML - file (usually ${HOME}/salome_<version>).

-

 -t <DIR> / --tmp=<DIR> -

-

The directory, which is used for temporary files. If used, this option - overrides the default temporary directory, given in the configuration - xml file (usually /tmp, see here).

-

-h /  --help -

-

Prints help information about available options.

-

-v / --version

-

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

- -

    -    
-To run the Installation Wizard in the GUI mode, just type runInstall. -

- -

 

- -

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:

- -

 

+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 default mode (GUI).
+The default installation settings can be overridden by using command line + options. Each option has a short and a long notation:

-

Figure 1: "Introduction" - page

+

-g / --gui

-

 

- -

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

- -

The Installation Wizard has two modes of the installation: basic (default) - and advanced. In the basic mode it is necessary just to enter the target - directory. If you want to use the advanced mode, click the "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 radio buttons 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 is necessary to - have gcc, Python, Qt and Sip - installed. Therefore all these products will be marked when you check - PyQt. This feature can be switched off by clicking the "Auto - set prerequisites products" checkbox.
 

- -

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

- -

 

- -

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

- -

 

- -

The box in the right part 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.  

- - - -

- -

 

- -

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

+
+Runs the Installation Wizard in the GUI + mode (this is the default mode). +
-

 

+

-b / --batch

-

The "Total disk space required:" field displays how - much disk space on the hard drive is required for installation of selected - products.

+
+Runs the Installation Wizard in the terminal + mode. +
-

 

+

-f FILE + / --file=FILE

+ +
+The XML configuration file to be used by + the Installation Wizard.  If this option is not used then the installation + script tries to define the Linux version and use the corresponding + XML file if it exists. For examle, for Linux + Mandrake 10.1  the config_Mandrake_10.1.xml  + file will be used by default. If no appropriate file is found, the file + config.xml will be used. This file refers to the basic target platform + which is Linux + Mandrake 10.1 for SALOME 3.0 and + newer. If config.xml file is not found either, a warning message + box is shown (in GUI mode) or printed to the console (in batch mode) and + the Installation Wizard quits. +
-  +

-d DIR + / --target=DIR

-

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

+
+The target directory SALOME platform is + to be installed to. If used, this option overrides the default target + directory, given in the configuration XML file (usually + ${HOME}/salome_<version>, + see here for more details). +
-

 

+

-t DIR + / --tmp=DIR

-

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.

+
+The directory, which should be used for + temporary files. If given, this option overrides the default temporary + directory, given in the configuration xml file (usually /tmp, see here for + more information). +
-

 

+

-a / --all-from-sources

+ +
+Forces all the products to be installed + from sources (including all SALOME modules). If this option is used, all + default installation modes for all 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 a time-consuming operation which can take more than + 24 hours depending on the computer. + +
-

In fact, temporary files - are not stored in the directory entered by user. The Installation Wizard - creates in this directory an additional folder named something like INSTALLWORKXXXXX where XXXXX is a unique number. - This allows to launch several Installation Wizards simultaneously. This - temporary directory is removed automatically when the installation finishes.

+

-h / --help

-

 

+
+Prints help information on the Installation + Wizard's use. +
-

The installation procedure also checks the available disk space in the - selected directories according to the products selected. If there is not - enough disk space on your hard drive you will see the corresponding error - message box.

+

-v / --version

-

 

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

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.

+

The installation procedure supports different + Linux platforms and installs various installation 3d-party + prerequisite products which are required by SALOME platform. As it was + mentioned above, the basic target platform for SALOME 3.0 and newer is + Linux Mandrake + 10.1.
+Use of configuration XML files gives a flexible way to modify the list + of products to be installed by the Installation Wizard without changing + the program source code. 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 Installation Wizard + GUI has been developed using Trolltech's + Qt 3.0.5 toolkit. 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. + The "Cancel" button closes the wizard window and quits + the installation procedure after the user's confirmation. The "Help" + button opens an additional window to show help information.

+ +

The first "Introduction" page is shown in Figure 1. + Skip this page by clicking "Next":

+ + + +

 

+ +

Intro page

+ +

Figure + 1: "Introduction" + page

+ +

In the second page you are proposed to + enter the target directory where the SALOME platform should be installed + to. You can also click "Browse..." and choose the destination folder using the + standard browse directory dialog box.
+If the directory you want to install products to does not exist you are + prompted to confirm directory creation. If you type a wrong directory + path, or if you do not have write permissions for the directory you use, + the corresponding message box is shown.

+ +

You can also change the temporary directory + (which is used to store temporary files required for the installation).
+In the bottom part of the window the total disk space required for the + installation and for the temporary files is displayed (see below for more + details).

+ +

In the GUI mode the Installation Wizard + provides two different options to install the SALOME platform: basic + (default option) and advanced. In the basic mode the user should enter the target installation + directory and temporary folder. All other installation options are taken + from the XML configuration file (see Fig.2):

+ + + +

 

+ +

Intro page

+ +

Figure + 2: "Installation settings" +

+ +

In addition, you have a choice to use + "Install all products from sources" check box. If this option + is turned on, all the products will be installed from the sources (using + their own build procedures). This check box corresponds to the --all-from-sources (-a) option of the runInstall script (see here). +

+ +

+ Installation of all products from sources is a long-time operation.

+ +

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

+ +

In the advanced mode you have a possibility + to select products to be installed. Each product can have several options + of installation: you have a possibility to use the native product (provided + with Linux distribution and installed in the system folders), install + already precompiled binaries, build the product from sources or not install + it at all. Available options and default option are taken from the XML + configuration file. You can mark the products you want to install by clicking + the corresponding radio-buttons in the list view in the left part of the + page.
+Note, that some products may require some other pre-requisite products + to be installed (or these prerequisite products should be already available + 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 is necessary to have gcc, + Python, Qt + and Sip installed. Therefore all these products will + also be  turned + on when you check on PyQt. This feature can be switched off by clicking + the "Automatic dependencies" checkbox. Turn on this checkbox if you want + all prerequisite products to be automatically checked when you select + some product to be installed. Turn off this checkbox if you want to disable + this feature.

+ + + +

 

+ +

Products page

+ +

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

+ +

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

+ +

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

+ +

In addition, when some SALOME sources + are selected, one more check box becomes available: "Build + SALOME sources". If this option + is turned on, the selected SALOME modules will be built and installed + from sources.
+ 

+ +

If this check + box is turned on, the corresponding SALOME module binaries package installation + is disabled, because of  SALOME + module sources and binaries packages conflict (see + Fig. 4 below).

+ + + +

Products page

+ +

Figure + 4: "Build SALOME sources" + check box usage

+ +

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

+ +The "Disk + space required:" field + displays how much disk space on the hard drive is required for installation + of selected products. + +

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

+ +

The installation procedure uses a special + directory to store temporary files. The "Space + for temporary files:" field + shows the information about required disk space on the hard drive for + extracting and compiling the selected products. You can change the temporary + directory - just type a path to the folder you want to use or click on + the corresponding "Browse..." button.
+ 

+ +

Actually, + temporary files are not stored directly in the directory entered by the + user. The Installation Wizard creates an additional folder in this directory + named something like INSTALLWORKXXXXX where XXXXX is a unique number. This allows + to launch 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 a corresponding error message box.

+ +

You are strongly recommended not to use directory names containing + spaces. Otherwise you can experience + some troubles with the installation. +

+ +

To proceed further click "Next". + At this moment the program will make some tests to check installation + settings: if there is enough disk space on the hard drive, check for native + products installation, dependencies (prerequisites) for each product you + have selected to be installed. If any test fails you will see the corresponding + warning message box. Otherwise the wizard will proceed to the next page: +

+ + + +

 

+ +

Choice page

+ +

Figure + 5: "Check your choice" + page

+ +

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

+ + + +

 

+ +

Progress page

+ +

Figure + 6: "Installation progress" + page

+ +

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

+ +

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

+ +

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

+ + + +

 

+ +

Progress page

+ +

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

+ +

The "Installation + Status" frame window shows + you the progress of installation. "Waiting" + status means that installation of this product has not been started yet. + The product currently being installed is marked as "Processing". All installed products have "Completed" status.

+ +

You can abort installation and close + the installation procedure using "Cancel" button.

+ +  + +

This button sends the signal "SIGTERM" to the + shell script. The script tries 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" + to go the Readme page:

+ + + +

 

+ +

Read page

+ +

Figure + 8: "Finish installation" + page

+ +

In this page you can read important information + about the Instalation Wizard itself and some tips: how to run and test + SALOME or how to build SALOME from the sources. This is the contents of + the README file which you can find in the root directory of the Installation + Wizard.
+You can also launch SALOME Desktop from this page 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 the user does + 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.
+The only exception is --all-from-sources (-a) option which enables special installation mode + in which all the products (including SALOME modules) are installed from + sources, ignoring the default mode defined in the XML configuration file + (see here for details).

+ +

 
+
+Batch mode

+ +

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 installation scripts collects + 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.

+ +

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

+ + 
+ + +
-

 

-

To proceed further click the "Next" button. At this - moment the program will make some tests to check installation settings: - whether there is enough disk space on the hard drive, whether native products - are preinstalled, and the dependencies (prerequisites) 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 follow to - the next page:

+

Notes on check products + version procedure

-  +Unfortunately there is no exact algorithm + to identify the product version under Linux platform. The information + in this section gives an idea how the version is checked for the native/preinstalled + products (this information refers to the base platform Linux + Mandrake 10.1; and the same algorithms + are used for other platforms).
+The general rule for all products is that the path to the binaries should + be set via the PATH environment variable, path to the libraries + should be set via the LD_LIBRARY_PATH variable and the python modules should be available + via the PYTHONPATH variable. + +

Note: + the information given in this section refers to the prerequisite products + for SALOME version 3.2.4.

-

+ -

 

+Version number is checked by gcc -dumpversion command. The gcc executable should be in the PATH environment variable. Version should be equal + to "3.4.1". It is recommended to use native gcc on Mandrake + 10.1. -

Figure 3: "Check - your choice" page

+ -

 

+Version number for tcl/tk can be found in tclConfig.sh and tkConfig.sh + files (TCL_VERSION and TK_VERSION variables correspondingly). Version number should + be equal to "8.4" (release number is not checked).
+Set the TCLHOME environment variable to the root directory of + tcl/tk installation.
+It is recommended to use native tcl/tk on Mandrake 10.1. -

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

+ -  +Version number is defined by version.hpp + file which is part of the boost distribution. This file defines the BOOST_VERSION macro which should be equal to "103100". + In addition the existence of boost libraries is checked.
+Set the BOOSTDIR environment variable if you have a preinstalled + version of boost. -

When you are sure that everything is OK, press the "Next" - button to follow to the next page.

+ -

 

+Version number is checked by python -V + command. The python executable should be in the PATH environment variable. Version number should + be equal to "2.3.4". It is recommended to use native Python + on Mandrake 10.1.
+Set the PYTHONHOME environment variable if you have a preinstalled + version of Python. -

 

+ -

 

+Version number is checked by swig -version command. The swig executable should be in the PATH environment variable. Version number should + be equal to "1.3.24". -

Figure 4: "Installation - progress" page

+ -

 

+Version number is defined by qglobal.h + file which is part of the Qt distribution. This file defines QT_VERSION_STR macro which should be equal to "3.3.3". + It is recommended to use native Qt on Mandrake 10.1.
+Set the QTDIR environment variable if you have a preinstalled + version of qt. -

To start installation of the selected products click "Start" - button. It launches the shell installation script and you will be able - to see the output of the script in the dialog's topmost  frame. - In case of any installation problems (for example, you have accidentally - removed the temporary directory) the script will ask you: "Would - you like to continue : (Y,N) ?". You can answer this question - by typing [Y] or [N] in the middle text edit control frame.

+ -

 

+msg2qm + is a Qt tool which is used to convert text *.po files to *.qm resource + files. Unfortunately this tool is not included to the Linux distribution + and provided only in Qt sources package. This is the reason why this tool + is supplied with the SALOME Installation Wizard.
+There is no way to check the version number of msg2qm tool. Just set MSG2QM_ROOT + environment variable if you have a preinstalled version of msg2qm tool. + -

press [Enter] when you finish - typing data.

+ -

 

+Version number is defined by Standard_Version.hxx file which is part of the Open CASCADE distribution. + This file defines OCC_VERSION_MAJOR, OCC_VERSION_MINOR and OCC_VERSION_MAINTENANCE macros which should refer to version 6.1.2.
+Set the CASROOT environment variable if you have a preinstalled + version of Open CASCADE. -

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 the product being installed is marked as "Processing". All installed products have - "Completed" description.

+ -

You can abort installation and close the installation procedure using - the "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. -

+Version number is defined by qwt_global.h + file which is part of the qwt distribution. This file defines QWT_VERSION_STR macro which should be equal to "4.2.0".
+Set the QWTHOME environment variable if you have a preinstalled + version of qwt. -

At the end of installation (when all selected products have been installed - successfully) you can go back to the previous pages to start a new installation - or click the "Next" button to go the Readme page:

+ -  +Version number is defined by libhdf5.settings file which is part of the hdf5 distribution. Version should be equal to 1.6.4.
+Set the HDF5HOME environment variable if you have a preinstalled + version of hdf5. -

+ -

 

+Unfortunately there is no formal way to + check med version number. We check existence of libmed.so.1.0.2 library + on the computer. If you have any problem with a preinstalled version of + med, please, reinstall it.
+Set the MED2HOME environment variable if you have a preinstalled + version of med. -

Figure 5: "Finish - installation" page

+ -

 

+Unfortunately there is no formal way to + check VTK version number. We just check the existence of libvtkCommon.so library on the computer and hope that it is + of version we need. If you have any problem with a preinstalled version + of Vtk, please, reinstall it.
+Set the VTKHOME environment variable if you have a preinstalled + version of Vtk. -

In this page you can read some 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 content 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 the "Launch - SALOME" button.

+ -

 

+We just check existence of some omniORB + libraries and executable on the computer, like libomniORB4.so.0.5, _omnipymodule.so.2.4, libCOSNotify4.so.0.1 and notifd.
+Set the OMNIORBDIR environment variable if you have a preinstalled + version of omniORB products. -

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 installation scripts collect - the environment, see  here.

+ -

 

+Version number is checked by sip -V + command. The sip executable should be in the PATH environment variable. Version number should + be equal to "4.1".
+Set the SIPDIR environment variable to the directory where + you have sip executable preinstalled. -

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.

+ -  +Version number is defined by pyqtconfig.py Python module file which is part of the PyQt + distribution. Version should be equal to "3.13".
+Set the PYQTDIR + environment variable if you have + a preinstalled version of PyQt. -

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

+ +Unfortunarely we can't find anything about + netgen version. We just check if NETGENROOT environment variable is set.
+Set the NETGENROOT environment variable if you have a preinstalled + version of netgen mesher. -
+
  +

Note: netgen 4.5 + provided with the SALOME installation Wizard has been patched to improve + its performance.

-

Notes on check products - version procedure

+ -

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

- -

 

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Product

-

Algorithm of checking

-

Preliminary steps before launching
-the installation procedure

-

Notes

gcc 3.4.1ver=`gcc - -dumpversion` -

-

It is recommended to use the native - gcc for Mandrake 10.1.
tcl 8.4.51) - 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 a preinstalled version of tcl.
-add a directory where libraries can be found to the LD_LIBRARY_PATH		Unfortunately there is no strict - way to check the tcl version number.
-It is recommended to use the native tcl/tk for Mandrake 10.1.
boost 1.31.01) 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 a preinstalled version of boostwe use file version.hpp in the boost distribution to get - the version information.
-ver should be equal to 103100.
Open CASCADE -

Technology 6.1

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 the existence of libStdPlugin.so in OpenCASCADE distribution,		set CASROOT - if you have a preinstalled version of Open CASCADEOpen CASCADE's Standard_Version.hxx - file provides the version information.
-ver should be equal to 6.1.
Python 2.3.41) - 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 the native Python for Mandrake 10.1.
Swig 1.3.24ver=`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 variableSwig should exist and ver - should be equal to 1.3.24.
Qt 3.3.31) - 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 a preinstalled version of qtQt's qglobal.h file provides version - information: ver should be equal - to 3.3.3.
-It is recommended to use the native Qt for 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 toolmsg2qm is a Qt tool used to convert - text *.po files to *.qm resource files. Unfortunately this tool is not - included in the Qt distribution and is 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.2.41) - QWTHOME variable should be set.
-2) check if libqwt.so.4.2.0 exists		set  QWTHOME - if you have a preinstalled version of qwtUnfortunately there is no strict - way to check the qwt version number.
-We try to find libqwt.so.4.2.0 in the ${QWTHOME}/lib - folder. 
Hdf 51.6.31) - 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 a preinstalled version of hdfWe 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.31) - MED2HOME variable should be set.
-2) existence of libmed.so.1.0.1		set MED2HOME - if you have a preinstalled version of medUnfortunately there is no strict - way to check the med version number.
-We try to find libmed.so.1.0.1 in ${MED2HOME}/lib - folder.
-If you have a problem with the preinstalled version of med, please, reinstall - it.
Vtk 4.2.61) - VTKHOME variable should be set.
-2) existence of libvtkCommon.so		set VTKHOME - if you have a preinstalled version of vtkUnfortunately there is no strict - way to check the VTK version number.
-We try to find libvtkCommon.so in ${VTKHOME}/lib/vtk - folder.
-If you have a problem with the preinstalled version of vtk, please, reinstall - it.
Netgen 4.5NETGENROOT variable - should be set. set NETGENROOT if - you have a preinstalled version of Netgen.Unfortunately we can't find anything about NETGEN version.
-We just check if the NETGENROOT - environment variable is set. The NETGEN version should be patched.
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.5
-4) existence of libCOSNotify4.so.0.1
-5) existence of notifd		set OMNIORBDIR - if you have a preinstalled version of omniWe try to find several omni libraries - and binaries in the ${OMNIORBDIR}/lib - and ${OMNIORBDIR}/bin directories.
Numeric 23.7ver=`python - -c 'import Numeric; print Numeric.__version__' 2>/dev/null`add the directory where you - have the preinstalled version of Numeric package to your PYTHONHOME - variableIf you have problem with the preinstalled - version of Numeric 23.7, please, reinstall it.
Sip 4.11) - SIPDIR variable should be set.
-2) ver=`${SIPDIR}/sip -V | awk '{print $1}'`		set SIPDIR - to the directory where you have sip preinstalledver - should be equal to 4.1.
PyQt 3.131) - PYQTDIR variable should be set.
-2) existence of qt.so library		set PYQTDIR - to the directory where you have PyQt preinstalledUnfortunately we can't exactly check - the PyQt version number.
-We just try to find qt.so in ${PYQTDIR}. - -

Note that PyQt officially doesn't support Qt 3.3.3, but nevertheless - it can be used.

Doxygen 1.4.61) - 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.4.6.
-If you have problems with the preinstalled version of doxygen, reinstall - it.
-It is recommended to use the native doxygen for Mandrake 10.1.
Graphviz 2.2.11) - existence of dot binary.
-2) ver=`dot -V 2>&1 - | awk '{print $3}'`		add the graphviz bin directory to - the PATH environment variableWe 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.2.0.MODULE - binaries should exist and ver - should be equal to 3.2.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.2.0.MODULE - sources should exist and ver should be equal to 3.2.0.
-
-

 

+Version number is checked by python -c 'import Numeric; + print Numeric.__version__' command. + The python executable should be in the PATH environment variable and Numeric module should be available for the Python (for + example it should be in the PYTHONPATH environment variable). Version number should + be equal to "23.7". If you have any problem with a preinstalled + version of Numeric 23.7, please, reinstall it.
+Add the directory where you have a preinstalled version of Numeric + package to the the PYTHONHOME + environment variable. -

 

+ -

For native products the 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 directories different from default - ones (not /usr/bin, /usr/lib...), it is recommended to follow - the above description. Or you should properly set PATH - and LD_LIBRARY_PATH variables - before starting the Installation Wizard. - Otherwise the installation script will fail to find the preinstalled products.

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

 

+ -

 

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

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 version numbers should coincide with the prerequisite. - Release number can be larger. This is done to give a possibility to use - native products for newer versions of Linux. If some native product has - a version number larger than the one required by the installation procedure, - the user will be prompted by the warning message like this: "You - have a newer version of gcc installed on your computer than that is required - (3.4.1). Continue?". You can press the "Yes" - button to proceed with the installation but in this case you should be - aware of what you are doing. SALOME binaries (including other products) - are compiled with the predefined prerequisites and most likely can not - be run successfully if these products are not found. This can be only - helpful if you intend to build all products from the sources.

+ -

 

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

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

+ +

Note: for some native products (e.g. gcc, Python) + the rules of version checking are not so strict as described above. Only + major and minor version numbers should coincide with the prerequisite. + Newer version of the product can also be used. If some native product + has version number larger than that required by the installation procedure, + the 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 click "Yes" to proceed with the installation but in this + case you should be aware of what you are doing. SALOME binaries (including + other products) are compiled with the predefined prerequisites and most + likely can not be run successfully if these products are not found. This + can be helpful only if you plan to build all products from sources.

+ + +

Pick up the environment

-

Please, read carefully the following information. This section describes - how the installation procedure collects the environment.

- -

After installing each product the shell script creates a special environment - file for each product in its target folder . The name of the file is generated - from the name of the product according to 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 allow to pick up all - environment settings which are necessary to build and launch SALOME. When - installing SALOME sources and/or binaries, the installation procedure - picks up all the settings files and generates 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 care about setting - all environment variables manually to build/launch SALOME. What you need - is just to use one of these scripts.

- -

This also concerns those products which are not currently installed. - For example, you install some SALOME binaries to the directory where you - have previously installed other products.  The installation procedure - still tries to collect the environment files from the target directory - if it finds necessary products there. If some product are 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...) 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 the 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 found in the target installation - root directory.

- -

 

- - -
+Please, read the following information carefully + . This section describes how the installation procedure generates the + environment scripts for the SALOME platform being installed. + +

After installing each product shell the + script creates a special environment file for the product in its installation + folder. The name of the file is generated from the name of product by + the following scheme: env_<product_name>.sh (for example env_Vtk.sh + for the Vtk). This file includes + all necessary environment settings. At the final step of the installation + the script picks up all the settings files and generates two common environment + files from them: salome.sh and salome.csh + for bash and csh shells correspondingly. Such approach helps + to save time when reinstalling products and you may not bother about setting + all environment variables manually to build/launch SALOME. What you simply + need is to source one of these environment files.

+ +

This also concerns those 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 environment files from the + target directory if it finds necessary products installed there. If some + product is not found in the target directory the corresponding section + of salome.sh/salome.csh files will be skipped.
+For native products (like gcc, + tcl, etc...) 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 the installation procedure finishes, if you want.

+ +  + +

Note: + as it was mentioned above there are other environment files which are + 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 gcc, tcl, etc...) the installation file

-

You can create your own configuration file. The Installation Wizard - can then 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. The default - file the Installation Wizard looks for if no command line arguments are - given, is config.xml. This section describes the structure of the - configuration file.
-XML tags are in bold blue, optional sections/tags are in brackets.

- -

<document> -
-    [ <config [ version=<install_wizard_version> ] You can create your own XML configuration + file. The Installation Wizard can then 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. 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.
+XML tags are in bold blue, optional sections/tags are in brackets. + +

<document> +
+    [ <config
+ color=#000000> [ version=<install_wizard_version> + ]
              [ - caption=<install_wizard_caption> ]
+ caption=<install_wizard_caption> ] +
              [ - copyright=<install_wizard_copyright>  ]
+ copyright=<install_wizard_copyright>  ]
              [ - license=<install_wizard_license_info> ]
+ license=<install_wizard_license_info> ] +
              [ - os=<target_platform> ]
-      />
-    ]
-    [ <path
+      />
+    ]    [ targetdir=<target_directory> ] -
+ color=#000000>
+    [ <path   [ targetdir=<target_directory> + ]
              [ - tempdir=<temp_directory>     ]
-      />
-    ]
-    [ <product
+      />
+    ]   name=<product_name>
+ color=#000000>
+    [ <button   label=<button_label>     
+              + [ tooltip=<button_tooltip> ] +
+              +   script=<button_script>   
+              + [ disable=<disable_flag>   ]
+      />
+    ]
+    [ + <button + ...
+      />
+    ]
+    [ + <product  + name=<product_name> +
                - version=<product_version>
+ version=<product_version> +
              [ context=<product_context>         ]
              [ description=<product_description> - ]
+ ]
                - install=<installation_mode>
+ install=<installation_mode> +
                - supported=<supported_installation_modes>
-                - disable=<disable_flag>
+ supported=<supported_installation_modes> +
+              [ + disable=<disable_flag>            ]
              [ pickupenv=<pickup_env_flag>       - ]
+ ]
                - dependancies=<list_of_prerequisites> 
+ dependancies=<list_of_prerequisites> 
                - installdiskspace=<install_disk_space>
+ installdiskspace=<install_disk_space> +
                - temporarydiskspace=<tmp_disk_space>
+ temporarydiskspace=<tmp_disk_space> +
                - script=<installation_script_name>
-      /> -
-    ]
-    [ <product
+      />
+    ]
+    [ + <product + ...
+      /> ...
-      /> -
-    ]
-    ... -
-</document>

+ color=#000000>
+    ]
+    ...
+</document>

<config> section

+ color=#000000><config> + section This is an optional section - it contains general - information the Installation Wizard itself. + color=#000000>This is an optional + section; it provides general information about the Installation Wizard + itself.
+
+Attributes: + +The application version + number to be shown in the caption. + + + + +The application main window caption - if + this string contains '%1' text the title will contain the version number + in this place (see above). + + + +The application copyright + information (shown in the first page). + + + + +The application license + information (shown in the first page). + + + +This parameter defines + the directory (relative from ./Products/BINARIES) where the Installation + Wizard will search precompiled binaries packages. If this tag is not provided, + binaries packages are looked for in the ./Products/BINARIES directory. +

<path> section

+ color=#000000><path> + section -This is an optional section - it contains default directories. +This is an optional section; it defines + default installation directories.
+
+Attributes: + +The target directory + - the path to the directory where products should be installed. + + -

<product> section

+The temporary directory + - the path to the directory for the temporary files. + +

<product> + section

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

<button> + section

+ +This is an optional section. It allows customization + of the last "Finish installation" page of the Installation Wizard by adding one + or more buttons in the lower part of the wizard's window. The script which + is attached to each such button, can perform some specific action, 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: + + + +This is the button + text. + + + +The button tooltip + (optional). + + + +The script attached + to the button. + + -  +

If + this optional flag has 'true' value, the corresponding button will not + appear in the "Finish installation" page - the section of XML file is silently ignored. 

-

If you add new products - to be installed with the Installation Wizard, you should also provide - the installation script for this product. See the next section for more - details.

+

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 its description in the configuration - file and create a bash installation script, following the rules described - in this section.
-There are some obligatory functions to be provided in this installation - script. These functions are automatically called by the 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. -

+When you want some product to be installed + with the Installation Wizard, you should add its description to the configuration + file and create the installation + script, following the rules described in this section.
+
+There are some obligatory functions which should be implemented in this + installation script. These functions are automatically called by the 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. + + +This function allows to check the version + of the product already installed on the computer. It should try to find + the product (native or preinstalled in the target directory) and check + its version. This helps to avoid unnecessary reinstallation. This is an + internal function and is not called from the master installation script. + + + + +This function is called when the 'use native' installation + mode is selected by the user. The function should try to find a native + version of the product and define possibility of its use. It should create + the environment file 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 native mode installation. + + + +This function is called when the 'install sources' + installation mode is selected by the user. The function is responsible + for building the product from the sources package. It should create the + environment file for the product in the temporary directory (see also + description of print_env() + function). It is not necessary to implement this function if you do not + provide sources mode installation. + + + +This function is called + when SALOME module is installed and the --all-from-sources (-a) option is used ("Build + SALOME sources" check box in + GUI mode). This function should be used to unpack SALOME sources package + and then call the build/install procedure for it.
+For more details please refer to the this + and this sections for more details. + + + +This function is called + when the '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 description of print_env() function). It is not necessary to implement + this function if you do not provide binaries mode installation. + + + +This function is called when the + 'not install' installation mode + is selected by the user. In this case the script should inspect the target + directory to try to find an already preinstalled product, pick up and + check the environment from there. See here + for more details. + + + +This function is in + charge of creating the environment script. It should create a 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. + + -The calling signature of the product installation - script is the following:
+This procedure corresponds to the pickupenv + tag of the configuration xml file (see previous section). It should call + the make_env procedure to perform the pick-up environment + procedure for the product.
+
+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> - - -

where
-<product_script_name> - installation script name (described in - configuration xml file);
-<function_name> - name of the 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 the 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 the product - should be installed to;
-<dependancies> - single-quoted list of prerequisite products, - separated by space;
-<product_name> - product name itself.

- -

 

- -

med-2.2.2.sh install_binary - /tmp/work ./Products/BINARIES/Mandrake10.1 /usr/salome 'gcc Hdf' med -

- -

+ +

where

+ +

<product_script_name> - installation script name (described in the + 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; Copy the 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.

+ color=#000000>
+<products_directory> - + directory where the sources/binaries package can be found. You should + provide the 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> - root + target directory where the product should be installed to;
+<dependancies> - single-quoted + list of prerequisite products, separated by space;
+<product_name> - product + name itself.

+ +

Example:
+med-2.2.3.sh install_binary /tmp/work ./Products/BINARIES/Mandrake10.1 + /usr/salome 'gcc Hdf' med

+ +

Copy the 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. +

+ + +
-
+  +

Customizing Readme page + buttons

+ +The Installation Wizard allows customizing + the look-n-feel of the last "Finish + installation" page. If + you want to add one or more buttons to this page in order to perform some + specific actions at the end of the installation (for example, to 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 the button, you need to create a script and put it + to 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. -  + + +This procedure is called by the Installation + Wizard when the "Finish + installation" page is displayed + and the status of the buttons should be modified according to the installation + options. This procedure should return 0 if the corresponding action can be performed + and, thus, the button should become enabled. Otherwise, it should return + 1 + - in this case the corresponding button will be disabled. + + + +This procedure is invoked when the user + clicks the button. This procedure should return 0 if the corresponding action is done successfully + and 1 + if any error occurs.
+
+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 function;
+<target_directory> - root + target directory where the product is installed to;
+<temp_folder> - temporary + files directory;
+ 

+ +

Note: The standard Installation Wizard buttons "Launch + SALOME" and "Release Notes" are implemented with this feature. + Refer to scripts start_salome.sh and release_notes.sh for 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.

+ + +
-
  - + +