From dbfd2ab2ef35bcb8f8ab1df280206938f895ad4a Mon Sep 17 00:00:00 2001 From: mpa Date: Mon, 18 Nov 2013 13:03:58 +0000 Subject: [PATCH] CMake: - update documentation considering new CMake build system --- doc/doxygen/doxfiles/install.dox | 36 +++++++++++++++----------------- 1 file changed, 17 insertions(+), 19 deletions(-) diff --git a/doc/doxygen/doxfiles/install.dox b/doc/doxygen/doxfiles/install.dox index bf5daa730..9f0c07806 100644 --- a/doc/doxygen/doxfiles/install.dox +++ b/doc/doxygen/doxfiles/install.dox @@ -6,34 +6,32 @@ The libraries in SALOME MED can be configured in several manners so that it can 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 : +The first step consists in preparing the CMake build precedure : \verbatim -cd ${MED_SRC} -./build_configure +mkdir MED_BUILD +cd ${MED_BUILD} +cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX=`pwd`/../MED_INSTALL ../ \endverbatim +, where is build mode (Release or Debug). + This will create SALOME MED libraries with link to the SALOME Kernel. Sometimes, 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 +mkdir MED_BUILD +cd ${MED_BUILD} +cmake -DCMAKE_BUILD_TYPE= -DCMAKE_INSTALL_PREFIX=`pwd`/../MED_INSTALL _DSALOME_MED_STANDALONE=ON ../ \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 SALOME MED : -- \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-med3=${MED3DIR} 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. +- \a -DSALOME_MED_PARTITIONER_METIS=ON enables metis graph library in MEDPartitioner, +- \a -DSALOME_MED_PARTITIONER_PARMETIS=ON enables parmetis graph library in MEDPartitioner, +- \a -DSALOME_MED_PARTITIONER_SCOTCH=ON enables scotch graph library in MEDPartitioner, +- \a -DSALOME_MED_MICROMED=ON build MED with MED file dependancy, +- \a -DSALOME_MED_ENABLE_PYTHON=ON builds PYTHON bindings, +- \a -DSALOME_MED_ENABLE_PARTITIONER builds MEDPartitioner, +- \a -DSALOME_MED_ENABLE_RENUMBER builds Renumber, +- \a -DSALOME_USE_MPI=ON uses MPI containers. */ -- 2.39.2