README

   1 *************************
   2 About SALOME GMSH plug-in
   3 *************************
   4
   5 \b GMSHPLUGIN plugin provides an integration of certain functionalities of the
   6 well known <a href="http://www.geuz.org/gmsh/"><b>Gmsh three-dimensional finite
   7 element mesh generator</b></a>.
   8
   9 It is capable of meshing 2D and 3D geometric entities. The plugin was especially
  10 developed to integrate the Gmsh compound functionality.
  11
  12 For more information please visit the SALOME platform web site:
  13
  14   <https://www.salome-platform.org/>
  15
  16 =======
  17 License
  18 =======
  19
  20 SALOME platform is distributed under the GNU Lesser General Public License.
  21 See COPYING file for more details.
  22
  23 ============
  24 Installation
  25 ============
  26
  27 --------------
  28 Pre-requisites
  29 --------------
  30
  31 SALOME platform relies on a set of third-party software; some of them are needed
  32 at build time only, while other ones are needed at runtime as well.
  33
  34 For more information about the pre-requisites please visit SALOME platform web
  35 site:
  36
  37 * Check Release Notes and Software Requirements of the latest SALOME release at
  38
  39   <https://www.salome-platform.org/?page_id=15/>
  40
  41 Note: SALOME GMSH plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry
  42 and SALOME Mesh as pre-requisites.
  43
  44 ------------------
  45 Basic Installation
  46 ------------------
  47
  48 The build procedure of the SALOME platform is implemented with CMake.
  49 In order to build the plug-in you have to do the following actions:
  50
  51 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  52
  53 2. Create a build directory:
  54
  55    % mkdir GMSHPLUGIN_BUILD
  56
  57 3. Configure the build procedure:
  58
  59    % cd GMSHPLUGIN_BUILD
  60    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  61
  62    where
  63    - <mode> is either Release or Debug (default: Release);
  64    - <installation_directory> is a destination folder to install SALOME GMSH
  65      plug-in (default: /usr);
  66    - <path_to_src_dir> is a path to the SALOME GMSH plug-in sources directory.
  67
  68    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME GMSH
  69    plug-in will be configured for installation to the /usr directory that requires
  70    root permissions to complete the installation.
  71
  72 4. Build and install:
  73
  74    % make
  75    % make install
  76
  77    This will install SALOME GMSH plug-in to the <installation_directory>
  78    specified to cmake command on the previous step.
  79
  80 -------------------
  81 Custom installation
  82 -------------------
  83
  84 SALOME GMSH plug-in supports a set of advanced configuration options;
  85 for more details learn CMakeLists.txt file in the root source directory.
  86
  87 You can also use other options of cmake command to customize your installation.
  88 Learn more about available options by typing
  89
  90    % cmake --help
  91
  92 =============
  93 Documentation
  94 =============
  95
  96 The directory doc contains additional documentation file of SALOME GMSH
  97 plug-in.
  98
  99 ===============
 100 Troubleshooting
 101 ===============
 102
 103 Please, send a mail to webmaster.salome@opencascade.com.