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