================================================================================
README
- PAL/SALOME Installation Wizard
+ SALOME Installation Wizard
================================================================================
Contents of this file:
3.3. Testing of the installed SALOME platform
4. How to build SALOME modules from sources
+ 4.1. General procedure
+ 4.2. Automatic build procedure: build.csh script
================================================================================
source salome.csh
where <KERNEL_ROOT_DIR> is KERNEL binaries directory, e.g.
- KERNEL_2.1.0 for the 2.1.0 version.
+ KERNEL_2.2.0 for the 2.2.0 version.
2.2. Launching of SALOME
After you set environment you can start SALOME. Go to the KERNEL
- module's binaries directory (KERNEL_2.1.0/bin/salome for the version
- 2.1.0) by using of cd command and then type:
+ module's binaries directory (KERNEL_2.2.0/bin/salome for the version
+ 2.2.0) by using of cd command and then type:
runSalome [<parameters>]
This will start SALOME according to the configuration parameters which
are described into salome.launch file, located in your home directory
( $HOME/.salome_<version-number>/salome.launch ),
- where <version_number> is number of PAL/SALOME version.
+ where <version_number> is number of SALOME version.
If this file does not exists, it is created on the first launch of
SALOME from <KERNEL_ROOT_DIR>/bin/salome/salome.launch.
--killall
Kill SALOME, running on all ports
--modules=<module>,<module>,...,<module>
- Use module(s), possible values are GEOM, SMESH, VISU, MED, SUPERV
+ Use module(s), possible values are GEOM,SMESH,VISU,MED,SUPERV
--embedded=<container>,<container>,...<container>
Start specified container(s) embedded in SALOME Session server
- (i.e. running in the same process), possible values are registry, study,
- moduleCatalog, cppContainer, pyContainer, supervContainer
+ (i.e. running in the same process), possible values are registry,
+ study, moduleCatalog, cppContainer, pyContainer, supervContainer
--standalone=<container>,<container>,...<container>
- Start standalone container(s), possible values are registry, study,
- moduleCatalog, cppContainer, pyContainer, supervContainer
+ Start standalone container(s), possible values are registry,
+ study, moduleCatalog, cppContainer, pyContainer, supervContainer
Note that there is no key which corresponds to the <plugin> tag.
This tag can be used currently only for SMESH module to point external
4. How to build SALOME modules from sources
- If you want to build SALOME modules from sources, 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
- modules sources in the /home/salome directory. The name of each module's
- sources directory depends on the version of the platform, for example,
- KERNEL_SRC_2.1.0 for KERNEL module of PAL/SALOME version 2.1.0.
+ This section describes the way how to build SALOME modules manually from
+ sources packages provided with Installation Wizard.
+ 4.1. General procedure
- The order of compilation and installation should be performed in accordance
- with modules dependancies:
+ If you want to build SALOME modules from sources, install all products
+ necessary 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
+ 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_2.2.0 for KERNEL module of SALOME version 2.2.0.
+
+ The order of compilation and installation should be performed according
+ to the dependancies between modules:
* KERNEL -> no dependancies
* GEOM -> KERNEL
* NETGENPLUGIN -> KERNEL, SMESH
* GHS3DPLUGIN -> KERNEL, SMESH
- Note: NETGENPLUGIN, GHS3DPLUGIN are optional components. You may skip compiling them if
- you do not plan to use NETGEN and/or GHS3D mesher algorithms.
- In general, each module (except KERNEL, of course) is optional for SALOME.
- If you do not need any module, just do not compile or install it.
+ Note: NETGENPLUGIN, GHS3DPLUGIN are optional components. You may skip
+ compiling them if you do not plan to use NETGEN and/or GHS3D mesher
+ algorithms.
+ In general, each module (except KERNEL, 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).
+
+ - go to KERNEL module's sources directory:
+
+ cd /home/salome/KERNEL_SRC_2.2.0
+
+ - set environment variables (use bash or csh script, depending on
+ your shell):
+
+ source salome.csh
+ or
+ source salome.sh
- - go to KERNEL module's sources directory:
+ - create a configuration script by typing
- cd /home/salome/KERNEL_SRC_2.1.0
+ ./build_configure
- - set environment variables (use bash or csh script, depending on
- your shell):
+ - go to the parent directory and create build directory:
- source salome.c[s]h
+ cd ..
+ mkdir KERNEL_build
- - create a configuration script by typing
+ - run configure script which will check the environment and create
+ Makefile files:
- ./build_configure
+ cd KERNEL_build
+ ../KERNEL_SRC_2.2.0/configure --prefix=/home/salome/KERNEL_install
- - go to the parent directory and create build directory:
+ Note, that --prefix option defines the directory where you want to
+ install KERNEL module after 'make install' procedure.
+ More about certain module's configure options you can learn by using
+ --help (-h) parameter.
- cd ..
- mkdir KERNEL_build
+ - build and install KERNEL module:
- - configure the sources and create Makefile files:
+ make
+ make install
- cd KERNEL_build
- ../KERNEL_SRC_2.1.0/configure --prefix=/home/salome/KERNEL_install
+ After you have completed this scenario, KERNEL module is built and
+ installed into /home/salome/KERNEL_install directory.
- Note, that --prefix option defines the directory where you want to install
- KERNEL module after make install procedure.
- More about certain module's configure options you can learn by typing
- --help (-h) parameter.
+ - set environment:
- - build and install KERNEL module:
+ * for bash:
- make
- make install
+ export KERNEL_ROOT_DIR=/home/salome/KERNEL_install
+ or
+ export KERNEL_ROOT_DIR=/home/salome/KERNEL_build
+ (if make install step was not performed).
- After you have completed this scenario, KERNEL module is built and
- installed into /home/salome/KERNEL_install directory.
+ * for csh:
- - set environment:
+ setenv KERNEL_ROOT_DIR /home/salome/KERNEL_install
+ or
+ setenv KERNEL_ROOT_DIR /home/salome/KERNEL_build
+ (if make install step was not performed).
- * 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).
+ - then repeat this scenario for other modules you want to build taking
+ into account the dependancies between modules (see dependancies table
+ above).
- * 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).
+ 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:
- - then repeat this scenario for other modules you want to build in accordance
- with modules dependancies.
+ * for bash:
- Note: if the compilation fails it may be caused by poor environment.
- In this case you should check that environment script you use (salome.csh
- or salome.sh) contains the following lines for each module:
+ export PATH=${<module>_ROOT_DIR}/bin/salome:${PATH}
+ export LD_LIBRARY_PATH=${<module>_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH}
+ export PYTHONPATH=${<module>_ROOT_DIR}/bin/salome:${PYTHONPATH}
+ export PYTHONPATH=${<module>_ROOT_DIR}/lib/salome:${PYTHONPATH}
+ export PYTHONPATH=${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH}
+ export PYTHONPATH=${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH}
- * for bash:
- export PATH=${<module>_ROOT_DIR}/bin/salome:${PATH}
- export LD_LIBRARY_PATH=${<module>_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH}
- export PYTHONPATH=${<module>_ROOT_DIR}/bin/salome:${PYTHONPATH}
- export PYTHONPATH=${<module>_ROOT_DIR}/lib/salome:${PYTHONPATH}
- export PYTHONPATH=${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH}
- export PYTHONPATH=${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH}
+ * for csh:
- * for csh:
- setenv PATH ${<module>_ROOT_DIR}/bin/salome:${PATH}
- setenv LD_LIBRARY_PATH ${<module>_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH}
- setenv PYTHONPATH ${<module>_ROOT_DIR}/bin/salome:${PYTHONPATH}
- setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/salome:${PYTHONPATH}
- setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH}
- setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH}
+ setenv PATH ${<module>_ROOT_DIR}/bin/salome:${PATH}
+ setenv LD_LIBRARY_PATH ${<module>_ROOT_DIR}/lib/salome:${LD_LIBRARY_PATH}
+ setenv PYTHONPATH ${<module>_ROOT_DIR}/bin/salome:${PYTHONPATH}
+ setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/salome:${PYTHONPATH}
+ setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome:${PYTHONPATH}
+ setenv PYTHONPATH ${<module>_ROOT_DIR}/lib/python2.2/site-packages/salome/shared_modules:${PYTHONPATH}
+ 4.2. Automatic build procedure: build.csh script
+
+ From version 2.2.0 SALOME Installation Wizard provides 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.
+
+ To use this script just install SALOME sources packages with
+ Installation Wizard, then cd to the SALOME isntallation directory
+ and type:
+
+ ./build.csh
+
+ and that's all.
+
+ By default, build.csh only compiles the modules but not installs them,
+ i.e. does not perform 'make install' step.
+ To do this, use -i option or -p <prefix> where <prefix> is target
+ directory.
+
+ If you want to build only some SALOME modules, just pass them as
+ parameters, e.g.:
+
+ ./build.csh -i KERNEL MED GEOM
+
+ The script also provides some other options which specify compiling
+ and installation parameters. You can learn about options by using
+ -h key:
+
+ ./build.csh -h
+
+ 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
+ in this case.
+
+ 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.
+
+ Note: use -d option carefully because in this case the script removes
+ existing (previously installed) SALOME modules.
+
================================================================================
