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   <http://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 Also, additional information can be found at SALOME platform web site:
  25
  26   <http://www.salome-platform.org/downloads/license/>
  27
  28 ============
  29 Installation
  30 ============
  31
  32 --------------
  33 Pre-requisites
  34 --------------
  35
  36 SALOME platform relies on a set of third-party softwares; some of them are needed
  37 at build time only, while other ones are needed in runtime also.
  38
  39 For more information about the pre-requisites please visit SALOME platform web
  40 site:
  41
  42 * Check Release Notes and Software Requirements of the latest SALOME release at
  43
  44   <http://www.salome-platform.org/downloads/current-version/>
  45
  46 * Pre-requisites page at SALOME web site:
  47
  48   <http://www.salome-platform.org/downloads/license/>
  49
  50 Note: SALOME Homard module needs SALOME KERNEL, SALOME GUI, SALOME Geometry and
  51 SALOME Mesh as 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 HOMARD_BUILD
  65
  66 3. Configure the build procedure:
  67
  68    % cd HOMARD_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 Homard
  74       module (default: /usr);
  75    - <path_to_src_dir> is a path to the SALOME Homard sources directory.
  76
  77    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME Homard
  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 Homard module to the <installation_directory>
  87    specified to cmake command on the previous step.
  88
  89 -------------------
  90 Custom installation
  91 -------------------
  92
  93 SALOME Homard 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 Homard module.
 106
 107 ===============
 108 Troubleshooting
 109 ===============
 110
 111 Please, send a mail to webmaster.salome@opencascade.com.