================================================================================
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_1.4.1 for the 1.4.1 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_1.4.1/bin/salome for the version
- 1.4.1) 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/salome.launch ).
+ ( $HOME/.salome_<version-number>/salome.launch ),
+ 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.
- You can modify SALOME launching options by editing salome.launch file:
+ You can modify SALOME launching options by editing
+ salome_<version_number>.launch file:
<Configuration-list>
<launchoptions>
<plugin name="..."/>
</module>
</modules-list>
- <containers-list>
- <containertype>...</containertype>
- </containers-list>
+ <embedded-list>
+ <embeddedserver>...</embeddedserver>
+ </embedded-list>
+ <standalone-list>
+ <standaloneserver>...</standaloneserver>
+ </standalone-list>
</Configuration-list>
Each parameter described in salome.launch file can be overrided by
--killall
Kill SALOME, running on all ports
--modules=<module>,<module>,...,<module>
- Use module, possible values are GEOM, SMESH, VISU, MED, SUPERV
- --containers=<container>,<container>,...<container>
- Start container of type, possible values are cpp,python,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
+ --standalone=<container>,<container>,...<container>
+ 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
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
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_1.4.1 for KERNEL module of PAL/SALOME version 1.4.1.
+ This section describes the way how to build SALOME modules manually from
+ sources packages provided with Installation Wizard.
+ 4.1. General procedure
+
+ 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.
- According to dependancies between SALOME modules, the order of compilation
- and installation is following:
+ The order of compilation and installation should be performed according
+ to the dependancies between modules:
- - KERNEL
- | _
- |_ GEOM |
- | |- SMESH
- | |_ NETGENPLUGIN (optinal)
- |_ MED _|
- | |
- | |_ VISU
- |
- |_ SUPERV
- |_ COMPONENT
- |_ PYCALCULATOR
+ * KERNEL -> no dependancies
+ * GEOM -> KERNEL
+ * MED -> KERNEL
+ * SMESH -> KERNEL, GEOM, MED
+ * VISU -> KERNEL, MED
+ * SUPERV -> KERNEL
+ * COMPONENT -> KERNEL
+ * PYCALCULATOR -> 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. 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
+
+ - create a configuration script by typing
+
+ ./build_configure
+
+ - go to the parent directory and create build directory:
+
+ cd ..
+ mkdir KERNEL_build
+
+ - run configure script which will check the environment and create
+ Makefile files:
- - go to KERNEL module's sources directory:
+ cd KERNEL_build
+ ../KERNEL_SRC_2.2.0/configure --prefix=/home/salome/KERNEL_install
- cd /home/salome/KERNEL_SRC_1.4.1
+ 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.
- - set environment variables (use bash or csh script, depending on
- your shell):
+ - build and install KERNEL module:
- source salome.c[s]h
+ make
+ make install
- - create a configuration script by typing
+ After you have completed this scenario, KERNEL module is built and
+ installed into /home/salome/KERNEL_install directory.
- ./build_configure
+ - set environment:
- - go to the parent directory and create build directory:
+ * 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).
+
+ - then repeat this scenario for other modules you want to build taking
+ into account the dependancies between modules (see dependancies table
+ above).
+
+ 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:
+
+ * 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:
+
+ 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
- cd ..
- mkdir KERNEL_build
+ 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.
- - configure the sources and create Makefile files:
+ To use this script just install SALOME sources packages with
+ Installation Wizard, then cd to the SALOME isntallation directory
+ and type:
- cd KERNEL_build
- ../KERNEL_SRC_1.4.1/configure --prefix=/home/salome/KERNEL_install
+ ./build.csh
- 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.
+ 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.
- - build and install KERNEL module:
+ If you want to build only some SALOME modules, just pass them as
+ parameters, e.g.:
- make
- make install
+ ./build.csh -i KERNEL MED GEOM
- After you have completed this scenario, KERNEL module is built and
- installed into /home/salome/KERNEL_install directory.
+ The script also provides some other options which specify compiling
+ and installation parameters. You can learn about options by using
+ -h key:
- - set environment:
+ ./build.csh -h
- * for bash:
- export KERNEL_ROOT_DIR=/home/salome/KERNEL_install
- or
- export KERNEL_ROOT_DIR=/home/salome/KERNEL_build
- (if make install is not done).
+ 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.
- * for csh:
- setenv KERNEL_ROOT_DIR /home/salome/KERNEL_install
- or
- setenv KERNEL_ROOT_DIR /home/salome/KERNEL_build
- (if make install is not done).
+ 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.
- - then repeat this scenario for other modules you want to build according
- to modules dependancies.
+ Note: use -d option carefully because in this case the script removes
+ existing (previously installed) SALOME modules.
================================================================================
