X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=README;h=f5d23367c3460304e7660585edbd96bfb30d6715;hb=0112887d4aa0e0a961cc23388ab3855a83838cc6;hp=d6254fc15f64753767318518665ab4fb436aefa9;hpb=512cfae50bac817a5fc76ee064e8207c5cbf0e45;p=tools%2Finstall.git diff --git a/README b/README index d6254fc..f5d2336 100644 --- a/README +++ b/README @@ -19,6 +19,7 @@ 4. How to build SALOME modules from sources 4.1. General procedure 4.2. Automatic build procedure: build.csh script + 4.3. Build SALOME using cmake ================================================================================ @@ -51,7 +52,7 @@ If the appropriate file is not found, the warning message is shown. If this option is not used then the installation script tries to define the Linux version and use the corresponding XML file. - For example, for the Linux Mandriva 2006.0 the config_Mandriva_2006.0.xml + For example, for the Linux Mandriva 2010.0 the config_Mandriva_2010.0.xml file will be used by default. -d DIR / --target=DIR @@ -122,13 +123,13 @@ source salome.csh where is KERNEL binaries directory, e.g. - KERNEL_5.1.2 for the 5.1.2 version. + KERNEL_6.5.0 for the 6.5.0 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.2/bin/salome for the version - 5.1.2) by using of 'cd' command and then type: + module's binaries directory (KERNEL_6.5.0/bin/salome for the version + 6.5.0) by using of 'cd' command and then type: runSalome [] @@ -154,7 +155,7 @@ - + @@ -266,11 +267,11 @@ then builds each product using the product's own compilation procedure. The installation time also depends on the computer and platform used. - For example, to install SALOME on Pentium IV-3GHz, Linux Mandriva 2006.0, + For example, to install SALOME on Pentium IV-3GHz, Linux Mandriva 2010.0, time of the installation is: - from binaries: ~15 minutes; - - from sources: more than 24 hours. + - from sources: more than 20 hours. 3.2. Log files @@ -293,7 +294,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. @@ -312,13 +313,22 @@ 4.1. General procedure + SALOME build procedure is based on the GNU auto-tools: + automake, autoconf, libtool, etc. This chapter describes the + steps that should be done in order to compile and install + SALOME modules using GNU aotu-tools. Note, that some modules support also + cmake-based build procedure as alternative, moreover, for + PARAVIS module only cmake-based procedure is + available. Please refer to the paragraph 4.3 for more + details about cmake-based build procedure. + If you want to build SALOME modules from sources, install all prerequisite 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.2 for KERNEL module of SALOME version 5.1.2. + KERNEL_SRC_6.5.0 for KERNEL module of SALOME version 6.5.0. Compilation and installation should be performed according to the dependencies between modules: @@ -331,15 +341,20 @@ * MED -> KERNEL, GUI * SMESH -> KERNEL, GUI, GEOM, MED * VISU -> KERNEL, GUI, MED - * SUPERV -> KERNEL, GUI + * YACS -> KERNEL, GUI + * PARAVIS -> KERNEL, GUI, MED, VISU + * HEXABLOCK -> KERNEL, GUI, GEOM + * HOMARD -> KERNEL, GUI, MED, SMESH + * JOBMANAGER -> 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 + * BLSURFPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH + * HexoticPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH, BLSURFPLUGIN + * HEXABLOCKPLUGIN -> KERNEL, GUI, MED, GEOM, SMESH, HEXABLOCK Sample modules: @@ -347,32 +362,43 @@ * 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 + * ATOMIC -> KERNEL, GUI + * ATOMGEN -> KERNEL, GUI + * ATOMSOLV -> KERNEL, GUI, ATOMGEN 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. - In general, each module (except for KERNEL and GUI, of course) is + Note: Meshing plug-ins BLSURFPLUGIN, HexoticPLUGIN, GHS3DPLUGIN 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) 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 to be built first (see dependencies table above). 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: - source ../env_products.csh + source ./env_products.csh or - source ../env_products.sh + source ./env_products.sh - create build directory for the KERNEL module: @@ -381,43 +407,37 @@ - create a configuration script by typing - ../KERNEL_SRC_5.1.2/build_configure + ../KERNEL_SRC_6.5.0/build_configure - run configure script which will check the environment and create Makefile files: - ../KERNEL_SRC_5.1.2/configure --prefix=/home/salome/KERNEL_install + ../KERNEL_SRC_6.5.0/configure --prefix=/home/user/salome/KERNEL-6.5.0 Note, that --prefix option defines the directory where you want to install KERNEL module after 'make install' procedure. configure script also accepts a lot of other parameters (for example, to build the module - in the optimized mode use --disable-debug --enable-production keys). + in the Release mode use --disable-debug --enable-production keys). 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-6.5.0 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-6.5.0 * 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-6.5.0 - then repeat this scenario for other modules you want to build taking into account the dependencies between modules (see dependencies table @@ -429,13 +449,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-6.5.0 (see above). 4.2. Automatic build procedure: build.csh and build.sh scripts @@ -456,15 +476,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 +494,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,13 +506,73 @@ 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. + 4.3. Build SALOME using cmake + + Some (but not all) SALOME modules can be built using + cmake. If you want to learn what modules can be built with + cmake, just check the root source directory and look for + CMakeLists.txt file or build_cmake script. + + This paragraph describes the steps that should be done in + order to build SALOME modules using cmake. + + For example, to build KERNEL module: + + - go to installation root directory (/home/user/salome in this example): + + cd /home/user/salome + + - to set environment variables use bash or csh script, depending on + your shell: + + source ./env_products.csh + or + source ./env_products.sh + + - generate CMakeLists.txt files: + + cd KERNEL_SRC_6.5.0 + ./build_cmake + cd .. + + Note, that this step is not required for PARAVIS module, + since it is already supplied with the CMakeLists.txt + files. For other modules, build_cmake script generates + CMakeLists.txt files from the Makefile.am files. + + - create build directory for the KERNEL module: + + mkdir KERNEL_build + cd KERNEL_build + + - run cmake + + cmake -DCMAKE_INSTALL_PREFIX=/home/user/salome/KERNEL-6.5.0 ../KERNEL_SRC_6.5.0 + + Note, that -DCMAKE_INSTALL_PREFIX option defines the directory where you want to + install KERNEL module after 'make install' procedure. You + can supply additional options to the cmake (for example, to + build the module in the Release mode use -DCMAKE_BUILD_TYPE=Release option). + + - build and install KERNEL module: + + make + make install + + After you have completed this scenario, KERNEL module is built and + installed into /home/user/salome/KERNEL-6.5.0 directory. + + - modify your environment scripts: + + * for bash: + + export KERNEL_ROOT_DIR=/home/user/salome/KERNEL-6.5.0 + + * for csh: + + setenv KERNEL_ROOT_DIR /home/user/salome/KERNEL-6.5.0 + ================================================================================