******
README
******

Copyright (C) 2014-2015 OPEN CASCADE

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either 
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful 
but WITHOUT ANY WARRANTY; without even the implied warranty of 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public  
License along with this library; if not, write to the Free Software 
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA

See http://www.salome-platform.org or email : webmaster.salome@opencascade.com

============
Introduction
============

This is an implementation of ACIS SAT interface to be used as plugin for
SALOME Geometry module. It provides functions to import CAD models
stored in ACIS format (*.sat files) into SALOME study and
export CAD models from SALOME to the *.sat files.

============
Installation
============

See the INSTALL file for more information.

=====
Usage
=====

1. Set environment (DO NOT FORGET to correct path)

   * Set ACISPLUGIN_ROOT_DIR variable that should point to the ACIS plugin
     installation directory. It is required for SALOME Geometry module to
     automatically detect a plugin (see APPENDIX below). For example:

   - for csh:

   % setenv ACISPLUGIN_ROOT_DIR /path/to/the/ACISPLUGIN

   - for bash:

   % export ACISPLUGIN_ROOT_DIR=/path/to/the/ACISPLUGIN

   * Set LD_LIBRARY_PATH variable to point to the OCCT ACIS/SAT XDE product
     libraries, for example:

   - for csh:

   % setenv ACIS_ROOT_DIR /path/to/the/ACIS-6.9.0
   % setenv LD_LIBRARY_PATH ${ACIS_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   - for bash:

   % export ACIS_ROOT_DIR=/path/to/the/ACIS-6.9.0
   % export LD_LIBRARY_PATH=${ACIS_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   * OCCT ACIS/SAT XDE product requires also an OCCT license library.
   Normally OCCT license library is distributed with OCCT ACIS/SAT XDE
   product, but it can also be distributed separately. In latter
   case you might need to set-up environment to point to the OCCT
   license library, as follows:

   - for csh:

   % setenv OCCLICENSE_ROOT_DIR /path/to/the/OCCLicense-6.9.0
   % setenv LD_LIBRARY_PATH ${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   - for bash:
   
   % export OCCLICENSE_ROOT_DIR=/path/to/the/OCCLicense-6.9.0
   % export LD_LIBRARY_PATH=${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   * Set CSF_SATDefaults variable to point to the OCCT ACIS/SAT XDE product
     resources directory, for example:

   - for csh:

   % setenv CSF_SATDefaults ${ACIS_ROOT_DIR}/src/XSTEPResourceAdv

   - for bash:

   % export CSF_SATDefaults=${ACIS_ROOT_DIR}/src/XSTEPResourceAdv

2. Usage in SALOME

   * Run SALOME and activate Geometry module.

   * Import the ACIS file:

   Menu File - Import...

   In the "Import" dialog box choose file type: ACIS Files ( *.sat ).
   Browse and select the file and click "Open" button. New object (shape)
   will appears in the SALOME object browser.

   * Export to the ACIS file:

   Select a shape in the SALOME object browser.

   Menu File - Export...

   In the "Export" dialog box choose file type: ACIS Files ( *.sat ).
   Enter the file name and click "Save" button.

===============
Troubleshooting
===============

Please, send a mail to webmaster.salome@opencascade.com

========
APPENDIX
========

Since SALOME version 7.4.0, Geometry module implements a mechanism to
automatically detect plugins. To set-up the plug-in to SALOME Geometry
module, it is just necessary to set ACISPLUGIN_ROOT_DIR environment
variable to point to the installation directory of ACIS plugin as described
in paragraph "Usage" above.

In earlier versions of SALOME there is no such mechanism. To use ACIS
plugin within SALOME Geometry module, it is necessary to specify 
GEOM_ENGINE_RESOURCES_DIR environment variable to point to the ACIS
plugin's resources directory, for example:

- for csh:

% setenv GEOM_ENGINE_RESOURCES_DIR ${ACISPLUGIN_ROOT_DIR}/share/salome/resources/acisplugin

- for bash:

% export GEOM_ENGINE_RESOURCES_DIR=${ACISPLUGIN_ROOT_DIR}/share/salome/resources/acisplugin