1. Running of the Installation Wizard
- You can run the Installation Wizard in two modes: batch and gui.
- It's root directory contains python script runInstall:
-
- [python] runInstall [-g|b] [-f <xml-file>] [-t <taget-dir>] [-tmp <tmp-dir>]
-
- -g
- Runs the Installation Wizard in the GUI mode. In this case
- only <xml-file> key is taken into account.
- This option is used by default.
-
- -b
- Runs the Installation Wizard in the batch mode.
-
- -f <xml-file>
- The configuration file to be used by the Installation Wizard.
- If this parameter is missed then the script tries to define
- the Linux version and uses corresponding xml file.
- For example, for the Mandrake 10.1 config_Mandrake10_1.xml file
- is supposed to be used by default. If the appropriate file
- is not found, config.xml is used by default. This file usually
- refers to the default target platform. For SALOME version 3.0.0
- and higher default target platform is Linux Mandrake 10.1.
-
- -t <target-dir>
- The target directory SALOME products to be installed to.
- If used, overloads target directory, given in the
- configuration xml file (usually /salome).
-
- -tmp <tmp-dir>
- The directory, which is used to contain temporary files.
- If used, overloads temporary directory, given in the
- configuration xml file (usually /tmp).
-
- -h
- Prints help information.
+ 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 opstions this script will launch the SALOME Installation
+ Wizard in the default mode (GUI). The default mode can be
+ overriden by using command line options. Each option has short
+ and long notations:
+
+ -g / --gui
+
+ Runs the Installation Wizard in the GUI mode (this is default
+ mode).
+
+ -b / --batch
+
+ Runs the Installation Wizard in command-line 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
+ is present. For examle, for the Linux Mandrake 10.1 the
+ config_Mandrake_10.1.xml file will be used by default. 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 newer. 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 SALOME platform 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 detail).
+
+ -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 for more detail).
+
+ -a / --all-from-sources
+
+ Force all products to be installed from sources including SALOME
+ modules.If this option is used all the default installation modes
+ are ignored.
+
+ -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).
For more detailed information about the Installation Wizard refer to the
readme.html file in the doc directory.
the procedure of launching of SALOME. These shell scripts set all
necessary environment variables for all products you have installed.
These files are:
- * salome.csh + salome.sh in the KERNEL module's sources/binaries
- root directories; these files can be used for the launching of
- SALOME.
* env_products.csh + env_products.sh in the target directory;
+ these files can be used for the launching of SALOME.
+ * salome.csh + salome.sh in the KERNEL module's sources/binaries
+ root directories; these files are the copies of the
+ corresponding env_products.* files.
+ * env_build.csh + env_build.sh in the target directory;
these files contain minimal environment settings necessary
to build SALOME packages from sources (see paragraph 4).
source salome.csh
where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g.
- KERNEL_3.0.0 for the 3.0.0 version.
+ KERNEL_3.2.4 for the 3.2.4 version.
2.2. Launching of SALOME
After you set environment you can start SALOME. Go to the KERNEL
- module's binaries directory (KERNEL_3.0.0/bin/salome for the version
- 3.0.0) by using of cd command and then type:
+ module's binaries directory (KERNEL_3.2.4/bin/salome for the version
+ 3.2.4) by using of 'cd' command and then type:
runSalome [<parameters>]
- This will start SALOME according to the configuration parameters which
+ This will start SALOME according to the launching parameters which
are described in the configuration files: SalomeApp.xml in the
- <GUI_ROOT_DIR>/share/salome/resources folder and .SalomeApprc.<version_number>
- file, located in your home directory (where <version_number> is number
- of SALOME version). If the latest file does not exist, it is created during
- the first launch of SALOME.
+ <GUI_ROOT_DIR>/share/salome/resources/gui folder and
+ .SalomeApprc.<version_number> file, located in your home
+ directory (where <version_number> is SALOME version number).
+ If the user configuration file does not exist, it is automatically
+ created when exiting SALOME GUI.
You can modify SALOME launching options by editing your
- ~/.SalomeApprc.<version_number> file:
+ ~/.SalomeApprc.<version_number> file (not all the options are
+ listed below):
<section name="launch">
<parameter name="gui" value="yes"/>
</section>
Some parameters described in configuration file can be overrided by
- using of corresponding command-line keys for runSalome script:
+ using of corresponding command-line options for runSalome script:
--gui
Launch GUI desktop
time of the installation is:
- from binaries: ~10 minutes;
- - from sources: up to 7 hours.
-
+ - from sources: more than 24 hours.
+
3.2. Log files
The Installation Wizard displays the installation progress in the
When running, the script loads different modules (Geometry, Mesh, Med,
Post-Pro and Supervisor) and tests different functionality of these
- modules. You can watch script running progress in the python console
- window.
+ modules. You can watch script running progress in the embedded
+ python console window.
+
+ Note: the salome_test.py scripts require SALOME samples
+ module (SAMPLES_SRC) to be installed (this module includes set of sample
+ MED, Python, Supervisor graph, etc files).
+ Environment variable DATA_DIR should point to the SALOME
+ samples module directory.
================================================================================
If you want to build SALOME modules from sources, install all prerequisite
products, required for the platform and SALOME modules sources.
Then follow the scenario described below.
- In the scenario below it is supposed that you have installed SALOME
+ In this scenario it is supposed that you have installed SALOME
modules sources in the /home/salome directory. The name of each module
sources directory depends on the version of the platform, for example,
- KERNEL_SRC_3.0.0 for KERNEL module of SALOME version 3.0.0.
+ KERNEL_SRC_3.2.4 for KERNEL module of SALOME version 3.2.4.
The order of compilation and installation should be performed according
to the dependancies between modules:
Sample modules:
- * COMPONENT -> KERNEL
- * PYCALCULATOR -> KERNEL,
+ * COMPONENT -> KERNEL, MED
+ * PYCALCULATOR -> KERNEL, MED
+ * CALCULATOR -> KERNEL, MED
* HELLO -> KERNEL, GUI
- * PYHELLO -> KERNEL, GUI
+ * PYHELLO -> KERNEL
* LIGHT -> KERNEL, GUI
Note: SMESH plugins and sample modules are optional. You may skip
- compiling them if you do not plan to use NETGEN and/or GHS3D mesher
+ compiling them if you do not plan to use NETGEN and/or GHS3D meshing
algorithms and do not want to build samples.
In general, each module (except KERNEL and GUI, of course) is optional for
- create a configuration script by typing
- ../KERNEL_SRC_3.3.0/build_configure
+ ../KERNEL_SRC_3.2.4/build_configure
- run configure script which will check the environment and create
Makefile files:
- ../KERNEL_SRC_3.3.0/configure --prefix=/home/salome/KERNEL_install
+ ../KERNEL_SRC_3.2.4/configure --prefix=/home/salome/KERNEL_install
Note, that --prefix option defines the directory where you want to
install KERNEL module after 'make install' procedure. configure script
setenv MODULE_ROOT_DIR /home/salome/<MODULE_distribution>
where <MODULE_distribution> is a MODULE_build or MODULE_install (see above).
-
- 4.2. Automatic build procedure: build.csh script
- From version 2.2.0 SALOME Installation Wizard provides the script
+ 4.2. Automatic build procedure: build.csh and build.sh scripts
+
+ SALOME Installation Wizard includes two scripts which can be used
for automatic building of SALOME modules from sources packages:
- build.csh. It is installed into the top-level target directory
- (the same directory where env_products.[c]sh files are generated.
+ build.csh and build.sh. The scripts are installed into the top-level
+ installation directory (the same directory where env_products.[c]sh
+ files are generated).
- To use this script just install SALOME sources packages with
+ The build.csh and buils.sh scripts implement the same functionality
+ and support the same set of options, but for different shells.
+ Use build.csh script for csh and build.sh for bash.
+ The description below refers to both scripts.
+
+ To use the script just install SALOME sources packages with the
Installation Wizard, then cd to the SALOME installation directory
and type:
./build.csh
- and that's all.
-
By default, build.csh only compiles the modules but does not install them,
i.e. does not perform 'make install' step.
- To do this, use -i option or -p <prefix> where <prefix> is target
- directory.
+ To do this, use -i option or -p <prefix> where <prefix> is the
+ directory SALOME modules should be installed to.
If you want to build only some SALOME modules, just pass them as
parameters, e.g.:
When you run build.csh at first time it is not necessary to pass
-b, -c parameters. The script detects if build procedure has not yet
- been performed and runs build_configure, configure procedures
+ been performed and runs build_configure, configure scripts
in this case automatically.
Note: for avoiding of collisions it is recommended not to install
Note: use -d option carefully because in this case the script removes
existing (previously installed) SALOME modules.
+ Note: please, take into account 'make install' step is
+ obligatory for the KERNEL module. Build directory of KERNEL
+ can not be pointed as KERNEL_ROOT_DIR. This is an exception
+ for the SALOME modules. So you should use one of options -i
+ or -p of build.sch script when building KERNEL module.
+
+ Note: build.(c)sh scripts do not modify the environment files
+ (env_products.csh, etc). You should do it by yourself.
+
================================================================================
