doc/user/doxygen/doxfiles/appendix/install.dox

   1 /*!
   2 \page install Configuring and Installing MED from sources
   3
   4 The install procedure of %MEDCoupling can handle a variety of configurations
   5 to suit the needs of its user. Instructions for configuring and
   6 installing the module can be found here.
   7 Partitioning and parallel functionalities are optional.
   8
   9 Assume that the library sources are located in \a MEDCOUPLING_SRC directory. Build and install directories are MEDCOUPLING_BUILD and MEDCOUPLING_INSTALL, respectively.
  10 The first step consists in preparing the CMake build precedure :
  11 \verbatim
  12 mkdir <MEDCOUPLING_BUILD>
  13 cd <MEDCOUPLING_BUILD>
  14 cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=<MEDCOUPLING_INSTALL> <MEDCOUPLING_SRC>
  15 \endverbatim
  16
  17 , where <Mode> is build mode (Release or Debug).
  18
  19 This will configure the library without splitting functionalities. The \ref parallel "parallel functionalities" will be compiled if an MPI version has been found.
  20
  21 The following options can be useful to configure MEDCoupling :
  22 - \a -DMEDCOUPLING_MED_PARTITIONER_METIS=ON enables metis graph library in MEDPartitioner,
  23 - \a -DMEDCOUPLING_MED_PARTITIONER_PARMETIS=ON enables parmetis graph library in MEDPartitioner,
  24 - \a -DMEDCOUPLING_MED_PARTITIONER_SCOTCH=ON enables scotch graph library in MEDPartitioner,
  25 - \a -DMEDCOUPLING_MED_MICROMED=ON build MED with MED file dependancy,
  26 - \a -DMEDCOUPLING_MED_ENABLE_PYTHON=ON builds PYTHON bindings,
  27 - \a -DMEDCOUPLING_MED_ENABLE_PARTITIONER builds MEDPartitioner,
  28 - \a -DMEDCOUPLING_MED_ENABLE_RENUMBER builds Renumber,
  29 - \a -DMEDCOUPLING_USE_MPI=ON uses MPI containers.
  30
  31 According to set options and compilation environment, user may need to define some <prerequisite>_ROOT_DIR variables. For example if in SALOME environment:
  32 \verbatim
  33 export MEDFILE_ROOT_DIR=${MED3HOME}
  34 export METIS_ROOT_DIR=$METISDIR
  35 export SCOTCH_ROOT_DIR=$SCOTCHDIR
  36 export BOOST_ROOT_DIR=$BOOST_ROOT
  37 export GRAPHVIZ_ROOT_DIR=$GRAPHVIZHOME
  38 export CPPUNIT_ROOT_DIR=$CPPUNIT_ROOT
  39 \endverbatim
  40
  41 If using MPI, the PARMETIS_ROOT_DIR variable should be set.
  42 */