1 /*!\mainpage MEDMEM 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 + REMAPPER) that provides
26 mathematical structures and algorithms for interpolation and
29 You should be warned that the MEDMEM library still exists in the MED
30 module but is considered as deprecated:
32 - \ref medmem covers the %MEDMEM core library, i.e. the implementation
33 of meshes, supports and fields and the associated drivers (for
36 \section S2 A graphical interface for standard use cases
38 The MED module in SALOME comes with a graphical interface that helps
39 you to deal with most standard use case of fields manipulation. The
40 user guide can be found here:
42 - <a class="el" target="_new"
43 href="../../dev/MED/xmed-userguide.html">User guide of the MED Graphical Interface</a>
45 You could also be interested to read the software specifications and
46 requirements for this graphical module, and even the technical
47 considerations for development:
49 - <a class="el" target="_new"
50 href="../../dev/MED/xmed-specifications.html">Software
51 specifications and requirements of the MED Graphical Interface</a>
52 - <a class="el" target="_new"
53 href="../../dev/MED/xmed-develguide.html">Developer guide of the MED Graphical Interface</a>
55 \section S3 A set of tools for file manipulation
57 - Chapter \ref tools describes various tools based on MEDMEM that can
58 be helpful for handling MED files (conversion tools and splitting tools).
60 \section install Installation
61 The install procedure of the %MED SALOME module can handle a variety of configurations
62 to suit the needs of its user. Instructions for configuring and
63 installing the module an be found in \ref medmem_install.