X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Finstall.dox;h=ce7a819be5769a8208ec053d6c73ecf0926a31d7;hb=5aba5ed11e589ab75f2e13b1f91a7d5ed6314267;hp=8090ff92fc8c2817ba0827ceac20ee9fd8478434;hpb=f14439749926cca959747bb79fda10529520bd0b;p=modules%2Fyacs.git diff --git a/doc/salome/install.dox b/doc/salome/install.dox index 8090ff92f..ce7a819be 100644 --- a/doc/salome/install.dox +++ b/doc/salome/install.dox @@ -1,57 +1,55 @@ /*! \page INSTALL Installation instructions -NOT UP TO DATE %SALOME 4 -WORK in PROGRESS, INCOMPLETE DOCUMENT +NOT UP TO DATE AND INCOMPLETE DOCUMENT BUT CAN BE HELPFUL -You'll find here generic instructions for installing the SALOME2 platform. +You'll find here generic instructions for installing the SALOME platform. \section Summary -
    -
  1. \ref S1_install
    2. -
  2. \ref S2_install
    3. -
  3. \ref S3_install
    4. -
  4. \ref S4_install
    5. -
  5. \ref S5_install
    6. -
  6. \ref S6_install
    7. -
  7. \ref S7_install
    8. -
  8. \ref S8_install
    9. -
+-# \ref S1_install +-# \ref S2_install +-# \ref S3_install +-# \ref S4_install +-# \ref S5_install +-# \ref S6_install +-# \ref S7_install +-# \ref S8_install \section S1_install Quick Overview First of all, you have to check (or install if needed) the dependant software programs on your system. These programs are: -- common development tools as gcc, automake, autoconf and libtools. -- third party softwares used in SALOME building or runtime process +- common development tools as gcc, CMake tool. +- third party softwares used in %SALOME building or runtime process (python, OCC, VTK, ...) -Further details can be found in sections [2] and [3]. +Further details can be found in sections \ref S2_install and \ref S3_install. If the dependencies are installed on your system, then you have to set your shell environment to get access to the software components -(cf. [4]. "Preparing the shell environment"). +(cf. \ref S4_install). -The next step is to install the KERNEL (cf. [5] "Installing KERNEL"): +The next step is to install the KERNEL (cf. \ref S5_install): \code $ mkdir $ mkdir -$ cd -$ ./build_configure $ cd -$ /configure --prefix= +$ cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= ../ $ make $ make install \endcode +Where is build mode (Release or Debug), +is a destination folder to install KERNEL module of SALOME. + Then, the %SALOME components GEOM, MED, VISU, ... can be installed -with a similar procedure (cf. [6]). +with a similar procedure (cf. \ref S6_install). -Eventually, the platform ccodean be run by executing the shell script -runSalome (cf. [7]). Here, somme additionnal variables have to be set +Eventually, the platform can be run by executing the shell script +%runSalome (cf. \ref S7_install). Here, somme additionnal variables have to be set to describe the %SALOME runtime configuration (_ROOT_DIR, OMNIORB_CONFIG) @@ -69,13 +67,11 @@ If you have another platform, we suggest the following configuration for building process: - gcc-3.3.x or 3.4.x -- automake-1.7 or more (only aclocal is used) -- autoconf-2.59 -- libtool-1.5.6 +- CMake-2.8.8 or more remarks: -- This is the minimum level of automake, autoconf and libtool, if you need +- This is the minimum level of CMake, if you need to compile all the third party softwares (included OpenCascade 5.2.x). \section S3_install Third-party dependencies @@ -122,7 +118,7 @@ Additionnal software may be installed for optional features: In the following, we assume that all the third-party softwares are installed in the same root directory, named /prerequis. -Then, your file system should probably look like:: +Then, your file system should probably look like: \code /prerequis/Python-2.2.2 @@ -133,7 +129,7 @@ Then, your file system should probably look like:: \section S4_install Preparing the shell environment -Some variables have to be set to get acces to third-party software +Some variables have to be set to get access to third-party software components (include files, executable, library, ...) during building process and runtime. @@ -157,7 +153,7 @@ $ source prerequis.sh We use here the notation to specify the source directory of the KERNEL component. The shell environment is supposed to have -been set (cf. 4). +been set (cf. \ref S4_install). Installing the KERNEL from a source package needs three directories: @@ -182,84 +178,44 @@ $ mkdir $ mkdir \endcode -STEP 2: - build configure script - - go to directory and generate the "configure" script: - + go to the build directory + \code -$ cd -$ ./build_configure +$ cd \endcode - If it doesn't work, check your system automake tools as specified in - section [2]. - -STEP 3: +STEP 2: configure the building process - go to the build directory and execute the configuration process:: \code -$ cd -$ /configure --prefix= +$ cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX= ../ \endcode + Where is build mode(Release or Debug), + is a destination folder to install KERNEL module of SALOME. Note that must be an absolute path. - When the configure process is complete, check the status of - third-party softwares detection. You should have a status like:: - - \code - --------------------------------------------- - Summary - --------------------------------------------- - Configure - cc : yes - boost : yes - lex_yacc : yes - python : yes - swig : yes - threads : yes - OpenGL : yes - qt : yes - vtk : yes - hdf5 : yes - med2 : yes - omniORB : yes - occ : yes - sip : yes - pyqt : yes - qwt : yes - doxygen : yes - graphviz : no - openpbs : no - lsf : no - Default ORB : omniORB - ---------------------------------------------- - \endcode - -If a software get a status "no", then it's not "seen" in the system: + When the configure process is complete, check the status of cmake build. + You should not have the errors and warnings. All dependent products and packages must be found. + + If a software get a status "not found", then it is not "seen" in the system: - the software is not installed, or - the shell environment is not set correctly. -In this example, the software programs graphviz, openpbs and lsf are not -installed (optional for most usages). - - -STEP 4 : +STEP 3 : Building the binary files - Execute make in the directory:: + Execute make in the directory: \code $ make \endcode -STEP 5: +STEP 4: Installing binary files, scripts and documentation - Execute install target in the directory:: + Execute install target in the directory: \code $ make install @@ -267,9 +223,9 @@ $ make install \section S6_install Installing the SALOME components -TInstalling a component is done by following the same +Installing a component is done by following the same instructions as given for the KERNEL, replacing KERNEL by - (build_configure, configure, make, make install). +. You just have to be aware of the dependencies between components: @@ -277,7 +233,7 @@ You just have to be aware of the dependencies between components: - GEOM depends on KERNEL - SMESH depends on KERNEL, MED, GEOM - VISU depends on KERNEL, MED -- SUPERV depends on KERNEL +- YACS depends on KERNEL For example, installing the component SMESH needs the previous installation of the KERNEL component, and then the GEOM and MED components. @@ -294,23 +250,21 @@ building process of the SMESH component (STEP 3). \section S7_install Runtime -See SALOME_Application to define your own configuration of %SALOME and run it +See \ref SALOME_Application to define your own configuration of %SALOME and run it on one or several computers. This is the recommended way of configuration. The following explains the general principles. To run the %SALOME platform, the procedure is: -- set the shell environment to get acces to third-party softwares: - -\code +- set the shell environment to get access to third-party softwares: + \code $ source prerequis.sh -\endcode + \endcode - define the %SALOME configuration by setting the whole set of variables _ROOT_DIR. Here, you just have to set the - kernel and the components you need:: - + kernel and the components you need: \code $ export KERNEL_ROOT_DIR= $ export MED_ROOT_DIR= @@ -320,14 +274,12 @@ $ ... - define the CORBA configuration file by setting the variable OMNIORB_CONFIG. This variable must be set to a writable file path. The file may be arbitrary chosen and doesn't need to exist - before running. We suggest:: - + before running. We suggest: \code $ export OMNIORB_CONFIG=$HOME/.omniORB.cfg \endcode -- run the %SALOME platform by executing the script runSalome: - +- run the %SALOME platform by executing the script %runSalome: \code $KERNEL_ROOT_DIR/bin/salome/runSalome \endcode @@ -336,43 +288,39 @@ $KERNEL_ROOT_DIR/bin/salome/runSalome For convenience or customization, we suggest the following organisation: -- chose and create a root directory for the %SALOME platform, say +- choose and create a root directory for the %SALOME platform, say . - install the third-party softwares in a sub-directory "prerequis" - install the %SALOME components in a sub-directory "SALOME2" -- make personnal copies of the files prerequis.sh and runSalome in +- make personnal copies of the files prerequis.sh and %runSalome in : - \code $ cp /prerequis.sh /. $ cp /bin/salome/runSalome /. \endcode - Edit the file prerequis.sh and adjust it to your own configuration. -- define the SALOME2 configuration - +- define the SALOME2 configuration\n This step consists in setting the KERNEL_ROOT_DIR, the whole set of variables _ROOT_DIR you need, and the OMNIORB_CONFIG variable. - + \n We suggest to create a shell file envSalome.sh containing those settings. Then the configuration consists in loading envSalome.sh in the runtime shell: - -\code + \code $ source envSalome.sh -\endcode + \endcode - When installed with this file organisation, running %SALOME is done - with the following shell commands:: - + with the following shell commands: \code $ source /prerequis.sh $ source /envSalome.sh $ ./runSalome \endcode + */