X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=fa1a5f1a9cbb43d52a322cdb7f2c0ea04a368e49;hb=b0a22d84b4ffa96c45d700d89c4c43986f0ddfea;hp=5fc55a88e252ded64e188d65e6ae704dcc82cdf5;hpb=46aea6187586257403b64bfdefd1e3fd342de4fc;p=tools%2Finstall.git diff --git a/README b/README index 5fc55a8..fa1a5f1 100644 --- a/README +++ b/README @@ -122,13 +122,13 @@ source salome.csh where is KERNEL binaries directory, e.g. - KERNEL_5.1.1 for the 5.1.1 version. + KERNEL_5.1.3 for the 5.1.3 version. 2.2. Launching of SALOME After you set environment you can start SALOME. Go to the KERNEL - module's binaries directory (KERNEL_5.1.1/bin/salome for the version - 5.1.1) by using of 'cd' command and then type: + module's binaries directory (KERNEL_5.1.3/bin/salome for the version + 5.1.3) by using of 'cd' command and then type: runSalome [] @@ -154,7 +154,7 @@ - + @@ -293,7 +293,7 @@ import salome_test When running, the script loads different modules (Geometry, Mesh, Med, - Post-Pro and Supervisor) and tests various functionalities of these + Post-Pro) and tests various functionalities of these modules. You can watch the script execution progress in the embedded python console window. @@ -316,9 +316,9 @@ 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 + modules sources in the /home/user/salome directory. The name of each module sources directory depends on the version of the platform, for example, - KERNEL_SRC_5.1.1 for KERNEL module of SALOME version 5.1.1. + KERNEL_SRC_5.1.3 for KERNEL module of SALOME version 5.1.3. Compilation and installation should be performed according to the dependencies between modules: @@ -331,15 +331,15 @@ * MED -> KERNEL, GUI * SMESH -> KERNEL, GUI, GEOM, MED * VISU -> KERNEL, GUI, MED - * SUPERV -> KERNEL, GUI + * YACS -> KERNEL, GUI SMESH plugins: - * NETGENPLUGIN -> KERNEL, GUI, SMESH - * GHS3DPLUGIN -> KERNEL, GUI, SMESH - * GHS3DPRLPLUGIN -> KERNEL, GUI, SMESH - * HexoticPLUGIN -> KERNEL, GUI, SMESH - * BLSURFPLUGIN -> KERNEL, GUI, SMESH + * NETGENPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH + * GHS3DPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH + * GHS3DPRLPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH + * HexoticPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH + * BLSURFPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH Sample modules: @@ -347,15 +347,23 @@ * PYCALCULATOR -> KERNEL, MED * CALCULATOR -> KERNEL, MED * HELLO -> KERNEL, GUI - * PYHELLO -> KERNEL + * PYHELLO -> KERNEL, GUI * LIGHT -> KERNEL, GUI + * PYLIGHT -> KERNEL, GUI * RANDOMIZER -> KERNEL, GUI - * SIERPINSKY -> KERNEL, GUI, VISU, RANDOMIZER + * SIERPINSKY -> KERNEL, GUI, MED, VISU, RANDOMIZER 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. + Note: Meshing plug-ins BLSURFPLUGIN, HexoticPLUGIN and + GHS3DPRLPLUGIN require commercial license for the Distene + meshers in runtime mode. Moreover, BLSURFPLUGIN requires + blsurf product at the compilation time. Without it, the + BLSURFPLUGIN meshing plugin compilation will fail. Refer + to http://www.distene.com/ for more details. + In general, each module (except for KERNEL and GUI, of course) is optional for SALOME. If you do not need a certain module, just do not compile or install it. But remember that some modules require others @@ -363,9 +371,9 @@ To build KERNEL module: - - go to installation root directory (/home/salome in this example): + - go to installation root directory (/home/user/salome in this example): - cd /home/salome + cd /home/user/salome - to set environment variables use bash or csh script, depending on your shell: @@ -381,12 +389,12 @@ - create a configuration script by typing - ../KERNEL_SRC_5.1.1/build_configure + ../KERNEL_SRC_5.1.3/build_configure - run configure script which will check the environment and create Makefile files: - ../KERNEL_SRC_5.1.1/configure --prefix=/home/salome/KERNEL_install + ../KERNEL_SRC_5.1.3/configure --prefix=/home/user/salome/KERNEL-5.1.3 Note, that --prefix option defines the directory where you want to install KERNEL module after 'make install' procedure. configure script @@ -395,29 +403,23 @@ You can learn more about the configure of any modules by using --help (-h) parameter. - - build and (optionally) install KERNEL module: + - build and install KERNEL module: make make install After you have completed this scenario, KERNEL module is built and - installed into /home/salome/KERNEL_install directory. + installed into /home/user/salome/KERNEL-5.1.3 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). + export KERNEL_ROOT_DIR=/home/user/salome/KERNEL-5.1.3 * 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). + setenv KERNEL_ROOT_DIR /home/user/salome/KERNEL-5.1.3 - then repeat this scenario for other modules you want to build taking into account the dependencies between modules (see dependencies table @@ -429,13 +431,13 @@ * for bash: - export MODULE_ROOT_DIR=/home/salome/ + export MODULE_ROOT_DIR=/home/user/salome/ * for csh: - setenv MODULE_ROOT_DIR /home/salome/ + setenv MODULE_ROOT_DIR /home/user/salome/ - where is a MODULE_build or MODULE_install (see above). + where is a MODULE-5.1.3 (see above). 4.2. Automatic build procedure: build.csh and build.sh scripts @@ -456,15 +458,16 @@ ./build.csh - 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 where is the + By default, build.csh builds and installs all SALOME + modules. All modules are installed to the INSTALL subfolder + of the current directory. If you need to change the installation + directory, you can use -p option where is the directory SALOME modules should be installed to. - If you want to build only some SALOME modules, just pass them as - parameters, e.g.: + If you want to build only some subset of SALOME modules, + just pass them as parameters, e.g.: - ./build.csh -i KERNEL MED GEOM + ./build.csh -p /home/user/salome KERNEL MED GEOM The script also provides other options which specify compiling and installation parameters. You can learn about these options by using @@ -473,7 +476,7 @@ ./build.csh -h When you run build.csh for the first time it is not necessary to pass - -b, -c parameters. The script detects if build procedure has not yet + -b or -c parameters. The script detects if build procedure has not yet been performed and in this case runs build_configure, configure scripts automatically. @@ -485,12 +488,6 @@ Note: use -d option carefully because in this case the script removes the existing (previously installed) SALOME modules. - Note: please, take into your account that 'make install' step is - obligatory for the KERNEL module. Build directory of KERNEL - can not be indicated as KERNEL_ROOT_DIR. This is an exception - for the SALOME modules. So you should use either option -i - or -p of build.sch script when building KERNEL module. - Note: build.(c)sh scripts do not modify the environment files (env_products.csh, etc). You should do it by yourself.