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   <https://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 ============
  27 Installation
  28 ============
  29
  30 --------------
  31 Pre-requisites
  32 --------------
  33
  34 SALOME platform relies on a set of third-party software; some of them are needed
  35 at build time only, while other ones are needed at runtime as well.
  36
  37 For more information about the pre-requisites please visit SALOME platform web
  38 site:
  39
  40 * Check Release Notes and Software Requirements of the latest SALOME release at
  41
  42   <https://www.salome-platform.org/?page_id=15/>
  43
  44 Note: SALOME Netgen plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry and
  45 SALOME Mesh as pre-requisites.
  46
  47 ------------------
  48 Basic Installation
  49 ------------------
  50
  51 The build procedure of the SALOME platform is implemented with CMake.
  52 In order to build the plug-in you have to do the following actions:
  53
  54 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  55
  56 2. Create a build directory:
  57
  58    % mkdir NETGENPLUGIN_BUILD
  59
  60 3. Configure the build procedure:
  61
  62    % cd NETGENPLUGIN_BUILD
  63    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  64
  65    where
  66    - <mode> is either Release or Debug (default: Release);
  67    - <installation_directory> is a destination folder to install SALOME Netgen
  68      plug-in (default: /usr);
  69    - <path_to_src_dir> is a path to the SALOME Netgen plug-in sources directory.
  70
  71    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME Netgen
  72    plug-in will be configured for installation to the /usr directory that requires
  73    root permissions to complete the installation.
  74
  75 4. Build and install:
  76
  77    % make
  78    % make install
  79
  80    This will install SALOME Netgen plug-in to the <installation_directory>
  81    specified to cmake command on the previous step.
  82
  83 -------------------
  84 Custom installation
  85 -------------------
  86
  87 SALOME Netgen plug-in supports a set of advanced configuration options;
  88 for more details learn CMakeLists.txt file in the root source directory.
  89
  90 You can also use other options of cmake command to customize your installation.
  91 Learn more about available options by typing
  92
  93    % cmake --help
  94
  95 =============
  96 Documentation
  97 =============
  98
  99 The directory doc contains additional documentation file of SALOME Netgen plug-in.
 100
 101 ===============
 102 Troubleshooting
 103 ===============
 104
 105 Please, send a mail to webmaster.salome@opencascade.com.