doc/doxygen/doxfiles/intro.dox

   1 /*!
   2
   3 \mainpage Introduction
   4
   5 \section intro Contents
   6 This document is the user guide of the %MED SALOME module. The MED
   7 module consists in:
   8
   9 - \ref S1 to manipulate meshes and fields that conform
  10   to the MED data model. This library can be used in C++ programs as
  11   in python script for data processing on meshes and fields.
  12 - \ref S2 that exhibits some useful functions of the
  13   library for a graphical manipulation of data in standard use cases.
  14 - \ref S3 that can be used to process MED data files
  15
  16 \section S1 A library of functions for data processing
  17
  18 The figure below represents the layer structure of the packages of the
  19 library:
  20
  21 \image html medlayers_70pc.png
  22
  23 The fundamentals consists in three atomic libraries:
  24
  25 - \ref medcoupling that describes DataStructures used for cross process exchange of meshes and fields.
  26 - \ref medloader that provides I/O functions to the MED file format
  27 - \ref interptools (INTERP_KERNEL + ParaMEDMEM::MEDCouplingRemapper) that provides
  28   mathematical structures and algorithms for interpolation and
  29   localization.
  30
  31 \section S2 A graphical interface for standard use cases
  32
  33 The MED module in SALOME comes with a graphical interface that helps
  34 you to deal with most standard use case of fields manipulation. The
  35 user guide can be found here:
  36
  37 - <a class="el" target="_new"
  38   href="../../dev/MED/medop-userguide.html">User guide of the MED Graphical Interface (in french)</a>
  39
  40 You could also be interested to read the software specifications and
  41 requirements for this graphical module, and even the technical
  42 considerations for development:
  43
  44 - <a class="el" target="_new"
  45   href="../../dev/MED/medop-specifications.html">Software
  46   specifications and requirements of the MED Graphical Interface (in french)</a>
  47 - <a class="el" target="_new"
  48   href="../../dev/MED/medop-develguide.html">Developer guide of the MED Graphical Interface (in french)</a>
  49
  50 \section S3 A set of tools for file manipulation
  51
  52 - Chapter \ref tools describes various tools based on MEDLoader  that can
  53 be helpful for handling MED files (conversion tools and splitting tools).
  54
  55 \section install Installation
  56 The install procedure of the %MED SALOME module can handle a variety of configurations
  57 to suit the needs of its user. Instructions for configuring and
  58 installing the module an be found in \ref paramedmem_install.
  59
  60 */