README

   1 ================================================================================
   2                                      README
   3                    SALOME Professional Installation Wizard
   4 ================================================================================
   5
   6   Contents of this file:
   7
   8   1. Running of the Installation Wizard
   9
  10   2. Running of SALOME
  11      2.1. Setting of the environment for SALOME
  12      2.2. Launching of SALOME
  13
  14   3. Installation notes
  15      3.1. Time required for the installation
  16      3.2. Log files
  17      3.3. Testing of the installed SALOME platform
  18
  19   4. How to build SALOME from sources
  20
  21 ================================================================================
  22
  23   1. Running of the Installation Wizard
  24
  25      You can run the Installation Wizard in two modes: batch and gui.
  26      It's root directory contains python script runInstall.py:
  27
  28      [python] runInstall [-g|b] [-f <xml-file>] [-t <taget-dir>] [-tmp <tmp-dir>]
  29
  30      -g
  31           Runs the Installation Wizard in the GUI mode. In this case
  32           only <xml-file> key is taken into account.
  33           This option is used by default.
  34
  35      -b
  36           Runs the Installation Wizard in the batch mode.
  37
  38      -f <xml-file>
  39           The configuration file to be used by the Installation Wizard.
  40           If this parameter is missed then the script tries to define
  41           the Red Hat version and use corresponding xml file.
  42           For example, for the Red Hat 8.0 config_RedHat8_0.xml file
  43           is supposed to be used by default. If the appropriate file
  44           is not found, config.xml is used by default.
  45
  46      -t <target-dir>
  47           The target directory, SALOME products to be installed to.
  48           If used, overloads target directory, described in the
  49           configuration file.
  50
  51      -tmp <tmp-dir>
  52           The directory, which is used to contain temporary files.
  53           If used, overloads temporary directory, described in the
  54           configuration file.
  55
  56      -h
  57           Prints help information.
  58
  59      For more detailed information about the Installation Wizard refer to the
  60      readme.html file in the doc directory.
  61
  62 ================================================================================
  63
  64   2. Running of SALOME
  65
  66      This section describes how to run SALOME platform after its installation with
  67      the Installation Wizard.
  68
  69      2.1. Setting of the environment for SALOME
  70
  71           Installation Wizard creates some environment files to simplify
  72           the procedure of launching of SALOME. These shell scripts set all
  73           necessary environment variables for all products you have installed.
  74           These files are: salome.csh + salome.sh in the SALOME PRO sources and
  75           SALOME PRO binaries root directories and env_products.csh +
  76           env_products.sh in the target directory.
  77
  78           To set SALOME environment just type in the terminal window:
  79
  80                cd <SALOME_DIR>
  81                source salome.sh
  82           or
  83                cd <SALOME_DIR>
  84                source salome.csh
  85
  86           where <SALOME_DIR> is SALOME binaries directory, e.g. SalomePro-1.2d
  87           for the 1.2d version.
  88
  89
  90      2.2. Launching of SALOME
  91
  92           After you set environment you can start SALOME. Go to the SALOME
  93           binaries directory (SalomePro-1.2d for the version 1.2d) by using
  94           of cd command and then type:
  95
  96                salome --gui
  97
  98           This will start SALOME servers and launch GUI desktop. If you want
  99           to launch SALOME in the batch mode, use --batch option:
 100
 101                salome --batch
 102
 103           If you want to launch SALOME using specific port, use --port key:
 104
 105                salome --gui --port XXXX
 106
 107           where XXXX is a port number.
 108           Note, that in this case you have to write the same port number into
 109           your ORB configuration file, which should be referenced by the
 110           $(OMNIORB_CONFIG) environment variable (usually it is an omniORB.cfg
 111           file), e.g.:
 112
 113                ORBInitRef NameService=corbaname::<host-name>:<port-number>
 114
 115           <host-name> is a name of host where Naming Service should be run
 116           and <port-number> is a number of port to be used.
 117           The default port number is 2809. The using of non-default port
 118           is useful when it is necessary for several users to launch
 119           SALOME on the same host.
 120
 121           Use --help key to display additional information to learn other
 122           salome script options.
 123
 124           Note: salome script is included into SALOME package only from 1.2d
 125           version. In order to run salome for the previous versions you should
 126           use runSalome script from the bin sub-directory of SALOME:
 127
 128                cd bin
 129                runSalome
 130
 131 ================================================================================
 132
 133   3. Installation notes
 134
 135      3.1. Time required for the installation
 136
 137           Installation of all products which are necessary to build and
 138           start SALOME is a time-consuming process and needs from the user to be
 139           patient.
 140           The quickest way to install SALOME is installation from the binaries.
 141           In this mode the Installation Wizard just extracts all precompiled
 142           products from the corresponding archives.
 143           The installation from sources requires much more time than from
 144           binaries because in this case the Installation Wizard extracts and
 145           then builds each product using the product's own installation
 146           procedure.
 147           The installation time also depends on the computer and platform used.
 148           For example, to install SALOME on Pentium III-800, Linux Red Hat 8.0,
 149           time of the installation is:
 150
 151                - from binaries: ~10 minutes;
 152                - from sources: up to 7 hours.
 153
 154      3.2. Log files
 155
 156           The Installation Wizard displays the installation progress in the
 157           corresponding windows (see readme.html). The Wizard uses a temporary
 158           directory to store and build the products. During the installation
 159           it produces some log files in this directory. If you suspect that
 160           program hangs you can check the log files. These files have names
 161           in capital letters like CONFIGURE.LOG, MAKE.LOG or MAKEINSTALL.LOG.
 162
 163      3.3. Testing of installed SALOME platform
 164
 165           There is a python script which allows to test shortly all SALOME
 166           modules. This script can help to check if SALOME has been installed
 167           successfully.
 168           To test SALOME platform, run SALOME desktop (see section 2), then
 169           create a new study window (menu command 'File/New') and then type
 170           in the study's python console window:
 171
 172                import salome_test
 173
 174           When running, the script loads diferent modules (Geometry, SMESH, Med,
 175           Visu and Supervision) and tests different functionalty of these
 176           modules. You can watch script running progress in the python console
 177           window.
 178
 179 ================================================================================
 180
 181   4. How to build SALOME from sources
 182
 183      If you want to build SALOME from sources, please install all products
 184      necessary for the platform and then follow the scenario described below.
 185      In the sample scenario it is supposed that you have installed SALOME
 186      in the /home/salome directory. The name of the SALOME sources directory
 187      depends on the version of the platform, in the scenario it is
 188      SALOME_ROOT_1.2d (for the version 1.2d).
 189
 190      - go to SALOME sources directory:
 191
 192           cd /home/salome/SALOME_ROOT_1.2d
 193
 194      - set environment variables (use bash or csh script, depending on
 195        your shell):
 196
 197           sources salome.c[s]h
 198
 199      - create a configuration script by typing
 200
 201           ./build_configure
 202
 203      - go to the parent directory and create a build directory:
 204
 205           cd ..
 206           mkdir build
 207
 208      - configure the sources and create Makefile files:
 209
 210           cd build
 211           ../SALOME_ROOT_1.2d/configure --prefix=/home/salome/SALOME
 212
 213        --prefix option defines the directory where you want to install
 214        SALOME after make install procedure.
 215
 216      - build and install SALOME:
 217
 218           make
 219           make install
 220
 221      - build and install SALOME documentation if necessary:
 222
 223           cd doc
 224           make doc
 225           make install
 226
 227        The last step is not necessary for the SALOME of version 1.2d, because
 228        it is included into main make (and make install) step.
 229
 230        After you have completed this scenario, SALOME is built and installed
 231        into /home/salome/SALOME directory.
 232
 233 ================================================================================