1 *****************************
2 About SALOME MG-Tetra plug-in
3 *****************************
5 SALOME MG-Tetra plug-in adds DISTENE MG-Tetra (former GHS3D) meshing algorithm
6 to the SALOME Mesh module.
8 MG-Tetra meshing algorithm is destined for:
9 - Meshing of 3D geometric entities: solids are split into tetrahedral (pyramidal)
11 - Generating of 3D meshes from 2D meshes (triangles and quadrangles), working without
14 For more information please visit the SALOME platform web site:
16 <http://www.salome-platform.org/>
22 SALOME platform is distributed under the GNU Lesser General Public License.
23 See COPYING file for more details.
25 Also, additional information can be found at SALOME platform web site:
27 <http://www.salome-platform.org/downloads/license/>
37 SALOME platform relies on a set of third-party softwares; some of them are needed
38 at build time only, while other ones are needed in runtime also.
40 For more information about the pre-requisites please visit SALOME platform web
43 * Check Release Notes and Software Requirements of the latest SALOME release at
45 <http://www.salome-platform.org/downloads/current-version/>
47 * Pre-requisites page at SALOME web site:
49 <http://www.salome-platform.org/downloads/license/>
51 Note: SALOME MG-Tetra plug-in needs SALOME KERNEL, SALOME GUI, SALOME Geometry
52 and SALOME Mesh as pre-requisites.
58 The build procedure of the SALOME platform is implemented with CMake.
59 In order to build the plug-in you have to do the following actions:
61 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
63 2. Create a build directory:
65 % mkdir GHS3DPLUGIN_BUILD
67 3. Configure the build procedure:
69 % cd GHS3DPLUGIN_BUILD
70 % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
73 - <mode> is either Release or Debug (default: Release);
74 - <installation_directory> is a destination folder to install SALOME MG-Tetra
75 plug-in (default: /usr);
76 - <path_to_src_dir> is a path to the SALOME MG-Tetra plug-in sources directory.
78 Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME MG-Tetra
79 plug-in will be configured for installation to the /usr directory that requires
80 root permissions to complete the installation.
87 This will install SALOME MG-Tetra plug-in to the <installation_directory>
88 specified to cmake command on the previous step.
94 SALOME MG-Tetra plug-in supports a set of advanced configuration options;
95 for more details learn CMakeLists.txt file in the root source directory.
97 You can also use other options of cmake command to customize your installation.
98 Learn more about available options by typing
106 The directory doc contains additional documentation file of SALOME MG-Tetra
113 Please, send a mail to webmaster.salome@opencascade.com.