================================================================================
README
- SALOME Professional Installation Wizard
+ SALOME Installation Wizard
================================================================================
Contents of this file:
3.2. Log files
3.3. Testing of the installed SALOME platform
- 4. How to build SALOME from sources
+ 4. How to build SALOME modules from sources
+ 4.1. General procedure
+ 4.2. Automatic build procedure: build.csh script
================================================================================
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.py:
+ It's root directory contains python script runInstall:
[python] runInstall [-g|b] [-f <xml-file>] [-t <taget-dir>] [-tmp <tmp-dir>]
-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 Red Hat version and use corresponding xml file.
- For example, for the Red Hat 8.0 config_RedHat8_0.xml file
- is supposed to be used by default. If the appropriate file
- is not found, config.xml is used by default.
+ automatically the Linux platform and use the corresponding xml file
+ if there is one provided.
+ For example, for Linux Mandrake 10.1 config_Mandrake_10.1.xml file
+ will be used by default. If the appropriate file is not found,
+ default config.xml will be used. This file contains default
+ installation settings. From SALOME version 3.0.0
+ the 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, described in the
- configuration file.
+ 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, described in the
- configuration file.
+ If used, overloads temporary directory, given in the
+ configuration xml file (usually /tmp).
-h
Prints help information.
2. Running of SALOME
- This section describes how to run SALOME platform after its installation with
- the Installation Wizard.
+ This section describes how to run SALOME platform after its installation
+ with the Installation Wizard.
2.1. Setting of the environment for SALOME
Installation Wizard creates some environment files to simplify
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 SALOME PRO sources and
- SALOME PRO binaries root directories and env_products.csh +
- env_products.sh in the target directory.
+ 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 contain minimal environment settings necessary
+ to build SALOME packages from sources (see paragraph 4).
To set SALOME environment just type in the terminal window:
- cd <SALOME_DIR>
+ cd <KERNEL_ROOT_DIR>
source salome.sh
or
- cd <SALOME_DIR>
+ cd <KERNEL_ROOT_DIR>
source salome.csh
- where <SALOME_DIR> is SALOME binaries directory, e.g. SalomePro-1.2d
- for the 1.2d version.
-
+ where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g.
+ KERNEL_3.0.0 for the 3.0.0 version.
2.2. Launching of SALOME
- After you set environment you can start SALOME. Go to the SALOME
- binaries directory (SalomePro-1.2d for the version 1.2d) by using
- of cd command and then type:
-
- salome --gui
-
- This will start SALOME servers and launch GUI desktop. If you want
- to launch SALOME in the batch mode, use --batch option:
-
- salome --batch
-
- If you want to launch SALOME using specific port, use --port key:
-
- salome --gui --port XXXX
-
- where XXXX is a port number.
- Note, that in this case you have to write the same port number into
- your ORB configuration file, which should be referenced by the
- $(OMNIORB_CONFIG) environment variable (usually it is an omniORB.cfg
- file), e.g.:
-
- ORBInitRef NameService=corbaname::<host-name>:<port-number>
-
- <host-name> is a name of host where Naming Service should be run
- and <port-number> is a number of port to be used.
- The default port number is 2809. The using of non-default port
- is useful when it is necessary for several users to launch
- SALOME on the same host.
-
- Use --help key to display additional information to learn other
- salome script options.
-
- Note: salome script is included into SALOME package only from 1.2d
- version. In order to run salome for the previous versions you should
- use runSalome script from the bin sub-directory of SALOME:
-
- cd bin
- runSalome
+ 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:
+
+ runSalome [<parameters>]
+
+ 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 automatically
+ created during the first launch of SALOME.
+
+ You can modify SALOME launching options by editing your
+ ~/.SalomeApprc.<version_number> file:
+
+ <section name="launch">
+ <parameter name="gui" value="yes"/>
+ <parameter name="splash" value="yes"/>
+ <parameter name="file" value="no"/>
+ <parameter name="key" value="no"/>
+ <parameter name="interp" value="no"/>
+ <parameter name="logger" value="no"/>
+ <parameter name="xterm" value="no"/>
+ <parameter name="portkill" value="no"/>
+ <parameter name="killall" value="no"/>
+ <parameter name="modules" value="GEOM,SMESH,VISU,SUPERV,MED,COMPONENT"/>
+ <parameter name="embedded" value="SalomeAppEngine"/>
+ <parameter name="standalone" value="study,pyContainer,cppContainer,registry,moduleCatalog"/>
+ </section>
+
+ Some parameters described in configuration file can be overrided by
+ using of corresponding command-line options for runSalome script:
+
+ --gui
+ Launch GUI desktop
+ --logger
+ Use logger server
+ --xterm
+ Start each server in its own xterm console window
+ --portkill
+ Kill SALOME, running on the current port
+ --killall
+ Kill SALOME, running on all ports
+ --modules=<module>,<module>,...,<module>
+ Use module(s), possible values are GEOM,SMESH,VISU,MED,SUPERV,etc.
+ --embedded=<server>,<server>,...<server>
+ Start specified server/container(s) embedded in SALOME Session server
+ (i.e. running in the same process), possible values are registry,
+ study, moduleCatalog, cppContainer, registry
+ --standalone=<server>,<server>,...<server>
+ Start standalone server/container(s), possible values are registry,
+ study, registry, moduleCatalog, cppContainer, pyContainer, supervContainer.
+
+ Additional launch settings are given in other sections, which refer to certain
+ modules. For example, SMESH plugins which should be used in the SALOME launch
+ session can be mentioned in the <SMESH> section, e.g.:
+
+ <section name="SMESH">
+ <parameter name="name" value="Mesh"/>
+ <parameter name="icon" value="ModuleMesh.png"/>
+ <parameter name="plugins" value="StdMeshers,NETGENPlugin"/>
+ </section>
================================================================================
patient.
The quickest way to install SALOME is installation from the binaries.
In this mode the Installation Wizard just extracts all precompiled
- products from the corresponding archives.
+ products from the corresponding archives (except those products
+ which can be installed only by compiling from sources).
The installation from sources requires much more time than from
binaries because in this case the Installation Wizard extracts and
- then builds each product using the product's own installation
+ then builds each product using the product's own compilation
procedure.
The installation time also depends on the computer and platform used.
- For example, to install SALOME on Pentium III-800, Linux Red Hat 8.0,
+ For example, to install SALOME on Pentium IV-2GHz, Linux Mandrake 10.1,
time of the installation is:
- from binaries: ~10 minutes;
- - from sources: up to 7 hours.
+ - from sources: more than 24 hours.
+
+ Note, the most time-consuming process is compiling of CASCADE libraries from
+ sources - it takes about 90% of time needed for compilation of all products.
3.2. Log files
directory to store and build the products. During the installation
it produces some log files in this directory. If you suspect that
program hangs you can check the log files. These files have names
- in capital letters like CONFIGURE.LOG, MAKE.LOG or MAKEINSTALL.LOG.
+ in capital letters like CONFIGURE.LOG, MAKE.LOG, MAKEINSTALL.LOG, etc.
3.3. Testing of installed SALOME platform
successfully.
To test SALOME platform, run SALOME desktop (see section 2), then
create a new study window (menu command 'File/New') and then type
- in the study's python console window:
+ in the study's embedded python console window:
import salome_test
- When running, the script loads diferent modules (Geometry, SMESH, Med,
- Visu and Supervision) and tests different functionalty of these
- modules. You can watch script running progress in the python console
- window.
+ 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 embedded
+ python console window.
================================================================================
- 4. How to build SALOME from sources
+ 4. How to build SALOME modules from sources
+
+ This section describes the way how to build SALOME modules manually from
+ sources distribution provided with Installation Wizard.
+
+ 4.1. General procedure
+
+ 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 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.
+
+ The order of compilation and installation should be performed according
+ to the dependancies between modules:
+
+ Main SALOME modules:
+
+ * KERNEL -> no dependancies
+ * GUI -> KERNEL
+ * GEOM -> KERNEL, GUI
+ * MED -> KERNEL, GUI
+ * SMESH -> KERNEL, GUI, GEOM, MED
+ * VISU -> KERNEL, GUI, MED
+ * SUPERV -> KERNEL, GUI
+
+ SMESH plugins:
+
+ * NETGENPLUGIN -> KERNEL, GUI, SMESH
+ * GHS3DPLUGIN -> KERNEL, GUI, SMESH
+
+ Sample modules:
+
+ * COMPONENT -> KERNEL, MED
+ * PYCALCULATOR -> KERNEL, MED
+ * CALCULATOR -> KERNEL, MED
+ * HELLO -> 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 meshing
+ algorithms and do not want to build samples.
+
+ In general, each module (except KERNEL and GUI, of course) is optional for
+ SALOME. If you do not need any module, just do not compile or install
+ it. But remember that some modules require other ones to be built first
+ (see dependancies table above).
+
+ To build KERNEL module:
+
+ - go to installation root directory (/home/salome in this example):
+
+ cd /home/salome
+
+ - to set environment variables use bash or csh script, depending on
+ your shell:
+
+ source ../env_products.csh
+ or
+ source ../env_products.sh
+
+ - create build directory for the KERNEL module:
+
+ mkdir KERNEL_build
+ cd KERNEL_build
+
+ - create a configuration script by typing
+
+ ../KERNEL_SRC_3.0.0/build_configure
+
+ - run configure script which will check the environment and create
+ Makefile files:
+
+ ../KERNEL_SRC_3.0.0/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
+ accepts also a lot of other parameters (for example, to build the module
+ in the optimized mode use --disable-debug --enable-production keys).
+ More about certain module's configure options you can learn by using
+ --help (-h) parameter.
+
+ - build and (optionally) install KERNEL module:
+
+ make
+ make install
+
+ After you have completed this scenario, KERNEL module is built and
+ installed into /home/salome/KERNEL_install directory.
+
+ - modify your environment scripts:
+
+ * for bash:
+
+ export KERNEL_ROOT_DIR=/home/salome/KERNEL_install
+ or
+ export KERNEL_ROOT_DIR=/home/salome/KERNEL_build
+ (if make install step was not performed).
+
+ * for csh:
+
+ setenv KERNEL_ROOT_DIR /home/salome/KERNEL_install
+ or
+ setenv KERNEL_ROOT_DIR /home/salome/KERNEL_build
+ (if make install step was not performed).
- If you want to build SALOME from sources, please install all products
- necessary for the platform and then follow the scenario described below.
- In the sample scenario it is supposed that you have installed SALOME
- in the /home/salome directory. The name of the SALOME sources directory
- depends on the version of the platform, in the scenario it is
- SALOME_ROOT_1.2d (for the version 1.2d).
+ - then repeat this scenario for other modules you want to build taking
+ into account the dependancies between modules (see dependancies table
+ above).
- - go to SALOME sources directory:
+ Note: if the compilation fails it may be caused by bad environment.
+ In this case you should check that environment script you use
+ (salome.csh or salome.sh) contains the following lines for each module MODULE:
- cd /home/salome/SALOME_ROOT_1.2d
+ * for bash:
- - set environment variables (use bash or csh script, depending on
- your shell):
+ export MODULE_ROOT_DIR=/home/salome/<MODULE_distribution>
- sources salome.c[s]h
+ * for csh:
- - create a configuration script by typing
+ setenv MODULE_ROOT_DIR /home/salome/<MODULE_distribution>
- ./build_configure
+ where <MODULE_distribution> is a MODULE_build or MODULE_install (see above).
+
+ 4.2. Automatic build procedure: build.csh script
- - go to the parent directory and create a build directory:
+ From version 2.2.0 SALOME Installation Wizard includes the script
+ 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.
- cd ..
- mkdir build
+ To use this script just install SALOME sources packages with
+ Installation Wizard, then cd to the SALOME installation directory
+ and type:
- - configure the sources and create Makefile files:
+ ./build.csh
- cd build
- ../SALOME_ROOT_1.2d/configure --prefix=/home/salome/SALOME
+ 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.
- --prefix option defines the directory where you want to install
- SALOME after make install procedure.
+ If you want to build only some SALOME modules, just pass them as
+ parameters, e.g.:
- - build and install SALOME:
+ ./build.csh -i KERNEL MED GEOM
- make
- make install
+ The script also provides some other options which specify compiling
+ and installation parameters. You can learn about options by using
+ -h key:
- - build and install SALOME documentation if necessary:
+ ./build.csh -h
- cd doc
- make doc
- make install
+ 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 scripts
+ in this case automatically.
- The last step is not necessary for the SALOME of version 1.2d, because
- it is included into main make (and make install) step.
+ Note: for avoiding of collisions it is recommended not to install
+ SALOME binaries packages with Installation Wizard if you plan to build
+ SALOME modules from sources packages or to edit/comment all rows
+ in env_products.csh file concerning binaries packages.
- After you have completed this scenario, SALOME is built and installed
- into /home/salome/SALOME directory.
+ Note: use -d option carefully because in this case the script removes
+ existing (previously installed) SALOME modules.
================================================================================
