================================================================================
README
- SALOME Professional Installation Wizard
+ PAL/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
================================================================================
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.
+ the Red Hat version and uses 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.
-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.
-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.
-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;
+ * env_products.csh + env_products.sh in the target directory.
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_1.4.1 for the 1.4.1 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_1.4.1/bin/salome for the version
+ 1.4.1) 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 ).
+ 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:
+
+ <Configuration-list>
+ <launchoptions>
+ <gui>yes</gui>
+ <logger>no</logger>
+ <xterm>no</xterm>
+ <portkill>yes</portkill>
+ <killall>no</killall>
+ </launchoptions>
+ <modules-list>
+ <module name="...">
+ <plugin name="..."/>
+ </module>
+ </modules-list>
+ <containers-list>
+ <containertype>...</containertype>
+ </containers-list>
+ </Configuration-list>
+
+ Each parameter described in salome.launch file can be overrided by
+ using corresponding keys 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, possible values are GEOM, SMESH, VISU, MED, SUPERV
+ --containers=<container>,<container>,...<container>
+ Start container of type, possible values are cpp,python,superv
+
+ 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
+ meshers plugins which should be loaded by SMESH dynamically.
+ Refer <SMESH_ROOT_DIR>/doc/salome/tui/SMESH/PluginMeshers.html
+ for more information om meshers plugins.
================================================================================
import salome_test
- When running, the script loads diferent modules (Geometry, SMESH, Med,
- Visu and Supervision) and tests different functionalty of these
+ When running, the script loads diferent 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.
================================================================================
- 4. How to build SALOME from sources
+ 4. How to build SALOME modules from sources
- If you want to build SALOME from sources, please install all products
+ 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
- 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).
-
- - go to SALOME sources directory:
-
- cd /home/salome/SALOME_ROOT_1.2d
+ 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.
+
+ According to dependancies between SALOME modules, the order of compilation
+ and installation is following:
+
+ - KERNEL
+ | _
+ |_ GEOM |
+ | |- SMESH
+ | |_ NETGENPLUGIN (optinal)
+ |_ MED _|
+ | |
+ | |_ VISU
+ |
+ |_ SUPERV
+ |_ COMPONENT
+ |_ PYCALCULATOR
+
+ - go to KERNEL module's sources directory:
+
+ cd /home/salome/KERNEL_SRC_1.4.1
- set environment variables (use bash or csh script, depending on
your shell):
- sources salome.c[s]h
+ source salome.c[s]h
- create a configuration script by typing
./build_configure
- - go to the parent directory and create a build directory:
+ - go to the parent directory and create build directory:
cd ..
- mkdir build
+ mkdir KERNEL_build
- configure the sources and create Makefile files:
- cd build
- ../SALOME_ROOT_1.2d/configure --prefix=/home/salome/SALOME
+ cd KERNEL_build
+ ../KERNEL_SRC_1.4.1/configure --prefix=/home/salome/KERNEL_install
- --prefix option defines the directory where you want to install
- SALOME after make install procedure.
+ 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.
- - build and install SALOME:
+ - build and install KERNEL module:
make
make install
- - build and install SALOME documentation if necessary:
+ After you have completed this scenario, KERNEL module is built and
+ installed into /home/salome/KERNEL_install directory.
- cd doc
- make doc
- make install
+ - set environment:
+
+ * 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).
- The last step is not necessary for the SALOME of version 1.2d, because
- it is included into main make (and make install) step.
+ * 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).
- After you have completed this scenario, SALOME is built and installed
- into /home/salome/SALOME directory.
+ - then repeat this scenario for other modules you want to build according
+ to modules dependancies.
================================================================================
