INSTALL

   1 *************************
   2 Installation Instructions
   3 *************************
   4
   5 Copyright (C) 2014 Open CASCADE S.A.S.
   6
   7 This library is free software; you can redistribute it and/or
   8 modify it under the terms of the GNU Lesser General Public
   9 License as published by the Free Software Foundation; either
  10 version 2.1 of the License, or (at your option) any later version.
  11
  12 This library is distributed in the hope that it will be useful
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 Lesser General Public License for more details.
  16
  17 You should have received a copy of the GNU Lesser General Public
  18 License along with this library; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20
  21 See http://www.salome-platform.org or email : webmaster.salome@opencascade.com
  22
  23 ==============
  24 Pre-requisites
  25 ==============
  26
  27 XT plugin for SALOME Geometry module requires:
  28
  29 - SALOME, at least KERNEL module (http://www.salome-platform.org).
  30 - Open CASCADE Technology and OCCT Parasolid Import XDE product
  31   (http://www.opencascade.org).
  32
  33 ==================
  34 Basic Installation
  35 ==================
  36
  37 The build procedure of the XT plugin for SALOME Geometry module is
  38 created using CMake build system.
  39 In order to build the plugin you have to do the following actions:
  40
  41 1. Set an environment to point to the OCCT Parasolid XDE product, for example:
  42
  43    - for csh:
  44
  45    % setenv XT_ROOT_DIR /path/to/the/XT-6.7.0
  46    % setenv LD_LIBRARY_PATH ${XT_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  47
  48    - for bash:
  49
  50    % export XT_ROOT_DIR=/path/to/the/XT-6.7.0
  51    % export LD_LIBRARY_PATH=${XT_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  52
  53    Note, that OCCT Parasolid XDE product requires OCCT license library.
  54    Normally OCCT license library is distributed with OCCT Parasolid XDE
  55    product, but it can also be distributed separately. In latter
  56    case you might need to set-up environment to point to the OCCT
  57    license library, as follows:
  58
  59    - for csh:
  60
  61    % setenv OCCLICENSE_ROOT_DIR /path/to/the/OCCLicense-6.7.0
  62    % setenv LD_LIBRARY_PATH ${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  63
  64    - for bash:
  65
  66    % export OCCLICENSE_ROOT_DIR=/path/to/the/OCCLicense-6.7.0
  67    % export LD_LIBRARY_PATH=${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  68
  69 2. Create a build directory (in the example below, it is assumed
  70    that this directory is created at the same level as sources
  71    directory XTPLUGIN_SRC), for example:
  72
  73    % mkdir XTPLUGIN_BUILD
  74
  75 3. Configure the build procedure:
  76
  77    % cd XTPLUGIN_BUILD
  78    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> ../XTPLUGIN_SRC
  79
  80    where
  81    - <mode> is either Release or Debug;
  82    - <installation_directory> is a destination folder to install XT plugin.
  83
  84    By default (if CMAKE_INSTALL_PREFIX option is not given), XT plugin will be
  85    configured for installation to the /usr directory that requires root
  86    permissions to complete the installation.
  87
  88 4. Build and install XT plugin:
  89
  90    % make
  91    % make install
  92
  93    This will install XT plugin to the <installation_directory> specified
  94    with cmake command on previous step.
  95
  96 ===================
  97 Custom installation
  98 ===================
  99
 100 For setting unusual options for compilation or linking run the following
 101 commands o get details on some of the pertinent environment variables:
 102
 103    % cd XTPLUGIN_BUILD
 104    % ccmake ../XTPLUGIN_SRC
 105
 106 You can also use other options of cmake command to customize
 107 your installation. Learn more about available options by running
 108
 109    % cmake --help