1 /*!\mainpage SALOME MED user's guide
3 \section intro Introduction
4 This document is the user guide of the %MED SALOME module. The MED
7 - \ref S1 to manipulate meshes and fields that conform
8 to the MED data model. This library can be used in C++ programs as
9 in python script for data processing on meshes and fields.
10 - \ref S2 that exhibits some useful functions of the
11 library for a graphical manipulation of data in standard use cases.
12 - \ref S3 that can be used to process MED data files
14 \section S1 A library of functions for data processing
16 The figure below represents the layer structure of the packages of the
19 \image html medlayers_70pc.png
21 The fondamentals consists in three atomic libraries:
23 - \ref medcoupling that describes DataStructures used for cross process exchange of meshes and fields.
24 - \ref medloader that provides I/O functions to the MED file format
25 - \ref interptools (INTERP_KERNEL + ParaMEDMEM::MEDCouplingRemapper) that provides
26 mathematical structures and algorithms for interpolation and
29 \section S2 A graphical interface for standard use cases
31 The MED module in SALOME comes with a graphical interface that helps
32 you to deal with most standard use case of fields manipulation. The
33 user guide can be found here:
35 - <a class="el" target="_new"
36 href="../../dev/MED/medop-userguide.html">User guide of the MED Graphical Interface (in french)</a>
38 You could also be interested to read the software specifications and
39 requirements for this graphical module, and even the technical
40 considerations for development:
42 - <a class="el" target="_new"
43 href="../../dev/MED/medop-specifications.html">Software
44 specifications and requirements of the MED Graphical Interface (in french)</a>
45 - <a class="el" target="_new"
46 href="../../dev/MED/medop-develguide.html">Developer guide of the MED Graphical Interface (in french)</a>
48 \section S3 A set of tools for file manipulation
50 - Chapter \ref tools describes various tools based on MEDLoader that can
51 be helpful for handling MED files (conversion tools and splitting tools).
53 \section install Installation
54 The install procedure of the %MED SALOME module can handle a variety of configurations
55 to suit the needs of its user. Instructions for configuring and
56 installing the module an be found in \ref paramedmem_install.
61 \page paramedmem_install Configuring and Installing MED from sources
63 The libraries in SALOME MED can be configured in several manners so that it can run inside or outside the Salome platform.
64 Also, partitioning and parallel functionalities are optional.
66 The sources of the library are located in the \a MED_SRC directory.
67 The first step consists in preparing the configuration of the library :
73 This will create SALOME MED libraries with link to the SALOME Kernel.
74 Sometimes, if it is desirable to have a standalone version of the library to be used independently from SALOME, use :
77 ./build_configure --without-kernel
80 The library can then be configured :
84 ../MED_SRC/configure --prefix=`pwd`/../MED_INSTALL
87 This will configure the library without splitting functionalities. ParaMEDMEM will be compiled if an MPI version has been found.
89 The following options can be useful to configure SALOME MED :
90 - \a --enable-splitter=yes will trigger the compilation of the MEDSPLITTER tool,
91 - \a --with-metis=${METISDIR} will specify a location for the METIS library,
92 - \a --with-scotch=${SCOTCHDIR} will specify a location for the SCOTCH library,
93 - \a --with-med3=${MED3DIR} specifies a location for MED-file library,
94 - \a --with-hdf5=${HDF5DIR} specifies a location for the HDF5 library (must be the same as that used for the MED-file library)
95 - \a --with-lam=${LAMDIR} specifies an install path for a LAM MPI library,
96 - \a --with-mpich=${MPICHDIR} specifies an install path for a MPICH-1 library.