1 *************************
2 Installation Instructions
3 *************************
5 Copyright (C) 2014-2015 OPEN CASCADE
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.
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.
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
21 See http://www.salome-platform.org or email : webmaster.salome@opencascade.com
27 XT plugin for SALOME Geometry module requires:
29 - SALOME, at least KERNEL and GEOM modules (http://www.salome-platform.org).
30 - Open CASCADE Technology and OCCT Parasolid Import XDE product
31 (http://www.opencascade.org).
32 - Other pre-requisite products, according to the SALOME pre-requisites list.
38 The build procedure of the XT plugin for SALOME Geometry module is
39 created using CMake build system.
40 In order to build the plugin you have to do the following actions:
42 1. Set an environment to point to the OCCT Parasolid XDE product, for example:
46 % setenv XT_ROOT_DIR /path/to/the/XT-6.9.0
47 % setenv LD_LIBRARY_PATH ${XT_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
51 % export XT_ROOT_DIR=/path/to/the/XT-6.9.0
52 % export LD_LIBRARY_PATH=${XT_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
54 Note, that OCCT Parasolid XDE product requires OCCT license library.
55 Normally OCCT license library is distributed with OCCT Parasolid XDE
56 product, but it can also be distributed separately. In latter
57 case you might need to set-up environment to point to the OCCT
58 license library, as follows:
62 % setenv OCCLICENSE_ROOT_DIR /path/to/the/OCCLicense-6.9.0
63 % setenv LD_LIBRARY_PATH ${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
67 % export OCCLICENSE_ROOT_DIR=/path/to/the/OCCLicense-6.9.0
68 % export LD_LIBRARY_PATH=${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
70 2. Create a build directory (in the example below, it is assumed
71 that this directory is created at the same level as sources
72 directory XTPLUGIN_SRC), for example:
74 % mkdir XTPLUGIN_BUILD
76 3. Configure the build procedure:
79 % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> ../XTPLUGIN_SRC
82 - <mode> is either Release or Debug;
83 - <installation_directory> is a destination folder to install XT plugin.
85 By default (if CMAKE_INSTALL_PREFIX option is not given), XT plugin will be
86 configured for installation to the /usr directory that requires root
87 permissions to complete the installation.
89 4. Build and install XT plugin:
94 This will install XT plugin to the <installation_directory> specified
95 with cmake command on previous step.
101 For setting unusual options for compilation or linking run the following
102 commands o get details on some of the pertinent environment variables:
105 % ccmake ../XTPLUGIN_SRC
107 You can also use other options of cmake command to customize
108 your installation. Learn more about available options by running