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