README

   1 ********************
   2 About SALOME ParaVis
   3 ********************
   4
   5 SALOME ParaVis wraps ParaView (http://www.paraview.org/) GUI and makes it available
   6 in SALOME application.
   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 ParaVis module needs the following SALOME modules and tools:
  38 - SALOME KERNEL
  39 - SALOME GUI
  40 - SALOME Med (optionally)
  41 - SALOME Geometry (optionally)
  42 - SALOME Mesh (optionally)
  43 - MedCoupling (optionally)
  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 PARAVIS_BUILD
  57
  58 3. Configure the build procedure:
  59
  60    % cd PARAVIS_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 ParaVis
  66       module (default: /usr);
  67    - <path_to_src_dir> is a path to the SALOME ParaVis sources directory.
  68
  69    Note: by default (if CMAKE_INSTALL_PREFIX option is not given), SALOME ParaVis
  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 ParaVis module to the <installation_directory>
  79    specified to cmake command on the previous step.
  80
  81 -------------------
  82 Custom installation
  83 -------------------
  84
  85 SALOME ParaVis 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 ParaVis module.
  98
  99 ===============
 100 Troubleshooting
 101 ===============
 102
 103 Please, send a mail to webmaster.salome@opencascade.com.