******
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 OCCT Canonical recognition (CANREC) interface
to be used as plugin for SALOME Geometry module. It provides functionality
to convert, if possible, a NURBS geometry (B-Spline / Bezier curve or surface)
to its analytical form (primitive curve or surface).
Please visit http://www.opencascade.org/support/products/canrec/ for more details
about OCCT Canonical recognition component.

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

See the INSTALL file for more information.

=====
Usage
=====

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

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

   - for csh:

   % setenv CANRECPLUGIN_ROOT_DIR /path/to/the/CANRECPLUGIN

   - for bash:

   % export CANRECPLUGIN_ROOT_DIR=/path/to/the/CANRECPLUGIN

   * Set LD_LIBRARY_PATH variable to point to the OCCT Canonical
     recognition product libraries, for example:

   - for csh:

   % setenv CR_ROOT_DIR /path/to/the/CR-6.9.0
   % setenv LD_LIBRARY_PATH ${CR_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   - for bash:

   % export CR_ROOT_DIR=/path/to/the/CR-6.9.0
   % export LD_LIBRARY_PATH=${CR_ROOT_DIR}/lib:${LD_LIBRARY_PATH}

   * OCCT Canonical recognition product requires also an OCCT license
   library. Normally OCCT license library is distributed with OCCT CR
   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}

2. Usage in SALOME

   * Run SALOME and activate Geometry module.

   * Invoke Canonical Recognition operation

   Menu New Entity - Advanced - Canonical Recognition

   In the "Canonical Recognition Construction" dialog box specify input shape,
   tolerance value and, optionally, switch on/off "Merge surfaces" and "Merge curves"
   check boxes. Press "Apply" or "Apply and Close' button to start canonical recognition
   operation.
   The result of the operation will be published in the study.

===============
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 CANRECPLUGIN_ROOT_DIR environment
variable to point to the installation directory of CANREC plugin as described
in paragraph "Usage" above.

SALOME CANREC plugin supports SALOME 7.6.0 and newer.