README

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