medtool/doc/user/doxygen/doxfiles/appendix/med-file.dox

   1 /*!
   2
   3 \page med-file Notes on the MED file format
   4
   5 \section med-file-intro Introduction
   6
   7 The MED file format is a specialization of the HDF5 standard, and existed well before
   8 MEDCoupling. Take a look at the
   9 <a class="el" href="http://www.hdfgroup.org/HDF5/">HDF5 Group website</a> for more details on HDF5 itself.
  10 It focuses on (potentially) big amount of data, and the design philosophy was to facilitate a
  11 parallel usage.
  12
  13 The official documentation of the MED-file format is available on-line (in French) in
  14 your SALOME installation at:
  15
  16 \code{.sh}
  17 ${MEDFILE_ROOT_DIR}/share/doc/html/index.html
  18 \endcode
  19
  20 Remember that the term "MED-file" denotes both:
  21 - a file format on disk (I/O)
  22 - a comprehensive low level C library to read/write MED files (now with a Python wrapping)
  23 and authored by Eric FAYOLLE  (EdF R&D).
  24
  25 \section med-file-struct What does it look like?
  26
  27 The picture below shows an UML-like diagram of the MED file format.
  28 We see for example that the mesh name is the unique key linking a \ref fields "field"
  29 to its supporting \ref meshes "mesh".
  30
  31 \image html med-file-uml.png "Functional diagram of the MED file format"
  32
  33 */