From: vbd Date: Tue, 2 Oct 2007 21:22:33 +0000 (+0000) Subject: *** empty log message *** X-Git-Tag: trio_trio_coupling~10 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=55029151094a1b976aada3a6a7b49fab6b394f65;p=tools%2Fmedcoupling.git *** empty log message *** --- diff --git a/doc/doxygen/main.dox b/doc/doxygen/main.dox index e6b62c4de..c2d9d1001 100644 --- a/doc/doxygen/main.dox +++ b/doc/doxygen/main.dox @@ -238,7 +238,38 @@ The classes that make up the API of the library are : */ /*! -\page medmem_install Configuring and Installing MEDMEM - -The MEDMEM library can be +\page medmem_install Configuring and Installing MEDMEM from sources + +The MEDMEM library can be configured in several manners so that it can run inside or outside the Salome platform. Also, partitioning and parallel functionalities are optional. + +The sources of the library are located in the \a MED_SRC directory. +The first step consists in preparing the configuration of the library : +\verbatim +cd ${MED_SRC} +./build_configure +\end verbatim + +This will create a MEDMEM library with link to the SALOME Kernel. If it is desirable to have a standalone version of the library to be used independently from SALOME, use : +\verbatim +cd ${MED_SRC} +./build_configure --without-kernel +\endverbatim + +The library can then be configured : +\verbatim +mkdir ../MED_BUILD +cd ../MED_BUILD +../MED_SRC/configure --prefix=`pwd`/../MED_INSTALL +\endverbatim + +This will configure the library without splitting functionalities. ParaMEDMEM will be compiled if an MPI version has been found. + +The following options can be useful to configure MEDMEM : +- \a --enable-splitter=yes will trigger the compilation of the MEDSPLITTER tool, +- \a --with-metis=${METISDIR} will specify a location for the METIS library, +- \a --with-scotch=${SCOTCHDIR} will specify a location for the SCOTCH library, +- \a --with-med2=${MED2DIR} specifies a location for MED-file library, +- \a --with-hdf5=${HDF5DIR} specifies a location for the HDF5 library (must be the same as that used for the MED-file library) +- \a --with-lam=${LAMDIR} specifies an install path for a LAM MPI library, +- \a --with-mpich=${MPICHDIR} specifies an install path for a MPICH-1 library. */ \ No newline at end of file