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 OCCT Canonical recognition (CANREC) interface
  28 to be used as plugin for SALOME Geometry module. It provides functionality
  29 to convert, if possible, a NURBS geometry (B-Spline / Bezier curve or surface)
  30 to its analytical form (primitive curve or surface).
  31 Please visit http://www.opencascade.org/support/products/canrec/ for more details
  32 about OCCT Canonical recognition component.
  33
  34 ============
  35 Installation
  36 ============
  37
  38 See the INSTALL file for more information.
  39
  40 =====
  41 Usage
  42 =====
  43
  44 1. Set environment (DO NOT FORGET to correct path)
  45
  46    * Set CANRECPLUGIN_ROOT_DIR variable that should point to the CANREC plugin
  47      installation directory. It is required for SALOME Geometry module to
  48      automatically detect a plugin (see APPENDIX below). For example:
  49
  50    - for csh:
  51
  52    % setenv CANRECPLUGIN_ROOT_DIR /path/to/the/CANRECPLUGIN
  53
  54    - for bash:
  55
  56    % export CANRECPLUGIN_ROOT_DIR=/path/to/the/CANRECPLUGIN
  57
  58    * Set LD_LIBRARY_PATH variable to point to the OCCT Canonical
  59      recognition product libraries, for example:
  60
  61    - for csh:
  62
  63    % setenv CR_ROOT_DIR /path/to/the/CR-6.9.0
  64    % setenv LD_LIBRARY_PATH ${CR_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  65
  66    - for bash:
  67
  68    % export CR_ROOT_DIR=/path/to/the/CR-6.9.0
  69    % export LD_LIBRARY_PATH=${CR_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  70
  71    * OCCT Canonical recognition product requires also an OCCT license
  72    library. Normally OCCT license library is distributed with OCCT CR
  73    product, but it can also be distributed separately. In latter
  74    case you might need to set-up environment to point to the OCCT
  75    license library, as follows:
  76
  77    - for csh:
  78
  79    % setenv OCCLICENSE_ROOT_DIR /path/to/the/OCCLicense-6.9.0
  80    % setenv LD_LIBRARY_PATH ${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  81
  82    - for bash:
  83
  84    % export OCCLICENSE_ROOT_DIR=/path/to/the/OCCLicense-6.9.0
  85    % export LD_LIBRARY_PATH=${OCCLICENSE_ROOT_DIR}/lib:${LD_LIBRARY_PATH}
  86
  87 2. Usage in SALOME
  88
  89    * Run SALOME and activate Geometry module.
  90
  91    * Invoke Canonical Recognition operation
  92
  93    Menu New Entity - Advanced - Canonical Recognition
  94
  95    In the "Canonical Recognition Construction" dialog box specify input shape,
  96    tolerance value and, optionally, switch on/off "Merge surfaces" and "Merge curves"
  97    check boxes. Press "Apply" or "Apply and Close' button to start canonical recognition
  98    operation.
  99    The result of the operation will be published in the study.
 100
 101 ===============
 102 Troubleshooting
 103 ===============
 104
 105 Please, send a mail to webmaster.salome@opencascade.com
 106
 107 ========
 108 APPENDIX
 109 ========
 110
 111 Since SALOME version 7.4.0, Geometry module implements a mechanism to
 112 automatically detect plugins. To set-up the plug-in to SALOME Geometry
 113 module, it is just necessary to set CANRECPLUGIN_ROOT_DIR environment
 114 variable to point to the installation directory of CANREC plugin as described
 115 in paragraph "Usage" above.
 116
 117 SALOME CANREC plugin supports SALOME 7.6.0 and newer.