README

   1 ******
   2 README
   3 ******
   4
   5 Copyright (C) 2014-2016 OPEN CASCADE
   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 Introduction
  25 ============
  26
  27 This is an implementation of Parasolid interface to be used as plugin for
  28 SALOME Geometry module. It provides a functions to import CAD models
  29 stored in Parasolid format (*.x_t, *.xt files) into SALOME study.
  30
  31 ============
  32 Installation
  33 ============
  34
  35 See the INSTALL file for more information.
  36
  37 =====
  38 Usage
  39 =====
  40
  41 1. Set environment (DO NOT FORGET to correct path)
  42
  43    * Set XTPLUGIN_ROOT_DIR variable that should point to the XT plugin
  44      installation directory. It is required for SALOME Geometry module to
  45      automatically detect a plugin (see APPENDIX below). For example:
  46
  47    - for csh:
  48
  49    % setenv XTPLUGIN_ROOT_DIR /path/to/the/XTPLUGIN
  50
  51    - for bash:
  52
  53    % export XTPLUGIN_ROOT_DIR=/path/to/the/XTPLUGIN
  54
  55    * Set LD_LIBRARY_PATH variable to point to the OCCT Parasolid XDE product
  56      libraries, for example:
  57
  58    - for csh:
  59
  60    % setenv XT_ROOT_DIR /path/to/the/XT-6.9.0
  61    % setenv LD_LIBRARY_PATH ${XT_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  62
  63    - for bash:
  64
  65    % export XT_ROOT_DIR=/path/to/the/XT-6.9.0
  66    % export LD_LIBRARY_PATH=${XT_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  67
  68    * OCCT Parasolid XDE product requires also an OCCT license library.
  69    Normally OCCT license library is distributed with OCCT Parasolid XDE
  70    product, but it can also be distributed separately. In latter
  71    case you might need to set-up environment to point to the OCCT
  72    license library, as follows:
  73
  74    - for csh:
  75
  76    % setenv OCCLICENSE_ROOT_DIR /path/to/the/OCCLicense-6.9.0
  77    % setenv LD_LIBRARY_PATH ${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  78
  79    - for bash:
  80
  81    % export OCCLICENSE_ROOT_DIR=/path/to/the/OCCLicense-6.9.0
  82    % export LD_LIBRARY_PATH=${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  83
  84 2. Usage in SALOME
  85
  86    * Run SALOME and activate Geometry module.
  87
  88    * Import the Parasolid file:
  89
  90    Menu File - Import...
  91
  92    In the "Import" dialog box choose file type: Parasolid Files ( *.x_t *.xt ).
  93    Browse and select the file and click "Open" button. New object (shape)
  94    will appears in the SALOME object browser.
  95
  96 ===============
  97 Troubleshooting
  98 ===============
  99
 100 Please, send a mail to webmaster.salome@opencascade.com
 101
 102 ========
 103 APPENDIX
 104 ========
 105
 106 Since SALOME version 7.4.0, Geometry module implements a mechanism to
 107 automatically detect plugins. To set-up the plug-in to SALOME Geometry
 108 module, it is just necessary to set XTPLUGIN_ROOT_DIR environment
 109 variable to point to the installation directory of XT plugin as described
 110 in paragraph "Usage" above.
 111
 112 In earlier versions of SALOME there is no such mechanism. To use XT
 113 plugin within SALOME Geometry module, it is necessary to specify
 114 GEOM_ENGINE_RESOURCES_DIR environment variable to point to the XT
 115 plugin's resources directory, for example:
 116
 117 - for csh:
 118
 119 % setenv GEOM_ENGINE_RESOURCES_DIR ${XTPLUGIN_ROOT_DIR}/share/salome/resources/xtplugin
 120
 121 - for bash:
 122
 123 % export GEOM_ENGINE_RESOURCES_DIR=${XTPLUGIN_ROOT_DIR}/share/salome/resources/xtplugin