README

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