README

   1 ***************************
   2 About SALOME Netgen plug-in
   3 ***************************
   4
   5 SALOME Netgen plug-in is destined for:
   6 - Meshing 1D, 2D and 3D geometric entities.
   7 - Splitting faces into triangular elements (quad-dominant mesh is also possible).
   8 - Splitting solids into tetrahedral elements (pyramids are constructed as a
   9   transition from quadrangles to tetrahedra).
  10 - Generating 3D meshes from 2D meshes, working without geometrical objects.
  11
  12 SALOME Netgen plug-in is integrated into SALOME platform via the SALOME Mesh
  13 module.
  14
  15 For more information please visit the SALOME platform web site:
  16
  17   <http://www.salome-platform.org/>
  18
  19 =======
  20 License
  21 =======
  22
  23 SALOME platform is distributed under the GNU Lesser General Public License.
  24 See COPYING file for more details.
  25
  26 Also, additional information can be found at SALOME platform web site:
  27
  28   <http://www.salome-platform.org/downloads/license/>
  29
  30 ============
  31 Installation
  32 ============
  33
  34 --------------
  35 Pre-requisites
  36 --------------
  37
  38 SALOME platform relies on a set of third-party software; some of them are needed
  39 at build time only, while other ones are needed at runtime as well.
  40
  41 For more information about the pre-requisites please visit SALOME platform web
  42 site:
  43
  44 * Check Release Notes and Software Requirements of the latest SALOME release at
  45
  46   <http://www.salome-platform.org/downloads/current-version/>
  47
  48 * Pre-requisites page at SALOME web site:
  49
  50   <http://www.salome-platform.org/downloads/license/>
  51
  52 Note: SALOME Netgen plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry and
  53 SALOME Mesh as pre-requisites.
  54
  55 ------------------
  56 Basic Installation
  57 ------------------
  58
  59 The build procedure of the SALOME platform is implemented with CMake.
  60 In order to build the plug-in you have to do the following actions:
  61
  62 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  63
  64 2. Create a build directory:
  65
  66    % mkdir NETGENPLUGIN_BUILD
  67
  68 3. Configure the build procedure:
  69
  70    % cd NETGENPLUGIN_BUILD
  71    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  72
  73    where
  74    - <mode> is either Release or Debug (default: Release);
  75    - <installation_directory> is a destination folder to install SALOME Netgen
  76      plug-in (default: /usr);
  77    - <path_to_src_dir> is a path to the SALOME Netgen plug-in sources directory.
  78
  79    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME Netgen
  80    plug-in will be configured for installation to the /usr directory that requires
  81    root permissions to complete the installation.
  82
  83 4. Build and install:
  84
  85    % make
  86    % make install
  87
  88    This will install SALOME Netgen plug-in to the <installation_directory>
  89    specified to cmake command on the previous step.
  90
  91 -------------------
  92 Custom installation
  93 -------------------
  94
  95 SALOME Netgen plug-in supports a set of advanced configuration options;
  96 for more details learn CMakeLists.txt file in the root source directory.
  97
  98 You can also use other options of cmake command to customize your installation.
  99 Learn more about available options by typing
 100
 101    % cmake --help
 102
 103 =============
 104 Documentation
 105 =============
 106
 107 The directory doc contains additional documentation file of SALOME Netgen plug-in.
 108
 109 ===============
 110 Troubleshooting
 111 ===============
 112
 113 Please, send a mail to webmaster.salome@opencascade.com.