Salome HOME
Enhance doc on parallelism.
[tools/medcoupling.git] / doc / user / doxygen / doxfiles / appendix / install.dox
1
2 /*!
3 \page install Configuring and Installing MED from sources
4
5 The install procedure of the %MED SALOME module can handle a variety of configurations
6 to suit the needs of its user. Instructions for configuring and
7 installing the module can be found here.
8
9 The libraries in SALOME MED can be configured in several manners so that it can run inside or outside the Salome platform.
10 Also, partitioning and parallel functionalities are optional.
11
12 The sources of the library are located in the \a MED_SRC directory.
13 The first step consists in preparing the CMake build precedure :
14 \verbatim
15 mkdir MED_BUILD
16 cd ${MED_BUILD}
17 cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=`pwd`/../MED_INSTALL ../<MED_SRC>
18 \endverbatim
19
20 , where <Mode> is build mode (Release or Debug).
21
22 This will create SALOME MED libraries with link to the SALOME Kernel.
23 Sometimes, if it is desirable to have a standalone version of the library to be used independently from SALOME, use :
24 \verbatim
25 mkdir MED_BUILD
26 cd ${MED_BUILD}
27 cmake -DCMAKE_BUILD_TYPE=<Mode> -DCMAKE_INSTALL_PREFIX=`pwd`/../MED_INSTALL _DSALOME_MED_STANDALONE=ON ../<MED_SRC>
28 \endverbatim
29
30 This will configure the library without splitting functionalities. The 
31 \ref parallel "parallel functionalities" will be compiled if an MPI version has been found.
32
33 The following options can be useful to configure SALOME MED :
34 - \a -DSALOME_MED_PARTITIONER_METIS=ON enables metis graph library in MEDPartitioner,
35 - \a -DSALOME_MED_PARTITIONER_PARMETIS=ON enables parmetis graph library in MEDPartitioner,
36 - \a -DSALOME_MED_PARTITIONER_SCOTCH=ON enables scotch graph library in MEDPartitioner,
37 - \a -DSALOME_MED_MICROMED=ON build MED with MED file dependancy,
38 - \a -DSALOME_MED_ENABLE_PYTHON=ON builds PYTHON bindings,
39 - \a -DSALOME_MED_ENABLE_PARTITIONER builds MEDPartitioner,
40 - \a -DSALOME_MED_ENABLE_RENUMBER builds Renumber,
41 - \a -DSALOME_USE_MPI=ON uses MPI containers.
42 */