doc/doxygen/main.dox

   1 /*!\mainpage MEDMEM user's guide
   2
   3 \image html MED_small.png
   4 \image latex MED_small.eps
   5 \anchor fig_MED_small
   6
   7 \section intro Introduction
   8 This document constitutes the user guide of the %MEDMEM library and of its related tools.
   9
  10 \section install Installation
  11 The install procedure of the %MEDMEM library can handle a variety of configurations
  12 to suit the needs of its user. Instructions for configuring and installing the library can be found in \ref medmem_install.
  13
  14 \section outline Outline
  15 This user guide contains three different chapters that covers the core %MEDMEM library, the %ParaMEDMEM library and the %MEDSPLITTER tool:
  16 - Chapter \ref medmem covers the %MEDMEM core library, i.e. the implementation of meshes, supports and fields and the associated drivers (for MED-file, VTK, GIBI).
  17 - Chapter \ref interpkernel describes the interpolation and
  18 localization library.
  19 - Chapter \ref paramedmem describes its MPI implementation, which is called %ParaMEDMEM.
  20 - Chapter \ref tools describes various tools based on MEDMEM  that can
  21 be helpful for handling MED files (conversion tools and splitting tools).
  22
  23 */