README

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