README

   1 *****************
   2 About SALOME Mesh
   3 *****************
   4
   5 SALOME Mesh module implements the functionalities for:
   6 - Creating meshes in different ways:
   7   * By meshing geometrical models previously created or imported by the Geometry
   8     component;
   9   * Bottom-up, using mesh edition operations, especially extrusion and revolution;
  10   * By generation of the 3D mesh from the 2D mesh (the latter can be either imported
  11     or manually created).
  12 - Importing and exporting meshes in various formats.
  13 - Modifying meshes with a vast array of dedicated operations.
  14 - Creating groups of mesh elements.
  15 - Filtering mesh entities (nodes or elements) using Filters functionality for
  16   creating groups and applying mesh modifications.
  17 - Viewing meshes in the VTK viewer and getting info on mesh and its sub-objects.
  18 - Applying to meshes Quality Controls, allowing to highlight important elements.
  19 - Taking various measurements of the mesh objects.
  20
  21 For more information please visit the SALOME platform web site:
  22
  23   <https://www.salome-platform.org/>
  24
  25 =======
  26 License
  27 =======
  28
  29 SALOME platform is distributed under the GNU Lesser General Public License.
  30 See COPYING file for more details.
  31
  32 ============
  33 Installation
  34 ============
  35
  36 --------------
  37 Pre-requisites
  38 --------------
  39
  40 SALOME platform relies on a set of third-party software; some of them are needed
  41 at build time only, while other ones are needed in runtime also.
  42
  43 For more information about the pre-requisites please visit SALOME platform web
  44 site:
  45
  46 * Check Release Notes and Software Requirements of the latest SALOME release at
  47
  48   <https://www.salome-platform.org/?page_id=15/>
  49
  50 Note: SALOME Mesh module needs SALOME KERNEL, SALOME GUI and SALOME Geometry as
  51 pre-requisites.
  52
  53 ------------------
  54 Basic Installation
  55 ------------------
  56
  57 The build procedure of the SALOME platform is implemented with CMake.
  58 In order to build the module you have to do the following actions:
  59
  60 1. Set up environment for pre-requisites (see "Pre-requisites" section above).
  61
  62 2. Create a build directory:
  63
  64    % mkdir SMESH_BUILD
  65
  66 3. Configure the build procedure:
  67
  68    % cd SMESH_BUILD
  69    % cmake -DCMAKE_BUILD_TYPE=<mode> -DCMAKE_INSTALL_PREFIX=<installation_directory> <path_to_src_dir>
  70
  71    where
  72    - <mode> is either Release or Debug (default: Release);
  73    - <installation_directory> is a destination folder to install SALOME Mesh
  74       module (default: /usr);
  75    - <path_to_src_dir> is a path to the SALOME Mesh sources directory.
  76
  77    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME Mesh
  78    module will be configured for installation to the /usr directory that requires
  79    root permissions to complete the installation.
  80
  81 4. Build and install:
  82
  83    % make
  84    % make install
  85
  86    This will install SALOME Mesh module to the <installation_directory>
  87    specified to cmake command on the previous step.
  88
  89 -------------------
  90 Custom installation
  91 -------------------
  92
  93 SALOME Mesh module supports a set of advanced configuration options;
  94 for more details learn CMakeLists.txt file in the root source directory.
  95
  96 You can also use other options of cmake command to customize your installation.
  97 Learn more about available options by typing
  98
  99    % cmake --help
 100
 101 =============
 102 Documentation
 103 =============
 104
 105 The directory doc contains additional documentation file of SALOME Mesh module.
 106
 107 ===============
 108 Troubleshooting
 109 ===============
 110
 111 Please, send a mail to webmaster.salome@opencascade.com.