doc/user/doxygen/doxfiles/index.dox

   1 /*!
   2
   3 \mainpage Welcome to the SALOME MED module!
   4
   5 The MED module gathers several powerful functionalities around the input and output data of
   6 simulation codes (meshes and fields mainly).
   7
   8 \image html projectionHQ_600.png "Example of a field interpolation between two 3D surfacic meshes"
   9
  10 The most common usage is to write dedicated code (C++ or Python) linking to the library,
  11 however a \ref gui "graphical user interface" is also available.
  12
  13 - If you don't know where to start, reading the \ref start "getting started" section and then
  14 taking a look at the <a class="el" href="tutorial/index.html">tutorial</a> is probably a good way to go.
  15 - If you are looking for a very specific point (how can I build a mesh from scratch,
  16  how do I write my data to a file, etc ...), taking a look at the \ref faq "FAQ" or at the numerous
  17  \ref examples "code examples" might help.
  18 - Finally people looking for the reference documentation of a given function (in C++ or Python) should
  19 take a look at the \ref ParaMEDMEM "API documentation". Only the C++ functions are documented, but
  20 the Python API has been designed to be used in a very similar fashion, provided you are aware of the
  21 \ref python-api "conventions used".
  22
  23 \section contents Contents
  24 This documentation is organized as follows:
  25 - \ref index (this page!)
  26 - \ref faq
  27 - \ref start
  28     - \ref intro-start
  29     - \ref terminology
  30     - \ref library
  31     - \ref functionalities
  32     - \ref python-api
  33 - <a class="el" href="tutorial/index.html">Tutorial - MEDCoupling/MEDLoader in Python</a>
  34 - \ref gui
  35 - \ref reference
  36     - \ref medcoupling
  37     - \ref medloader
  38     - \ref interpolation
  39     - \ref cpp
  40     - \ref distrib
  41     - \ref misc
  42   \if ENABLE_EXAMPLES
  43 - \ref examples
  44     - \ref medcouplingpyexamples
  45     - \ref medcouplingcppexamples
  46   \endif
  47
  48 - \ref appendix
  49     - \ref glossary
  50     - \ref med-file
  51     - \ref install
  52
  53 - \ref ParaMEDMEM "MEDCoupling (and other parallel classes) API documentation"
  54 - \ref MEDLoader "MEDLoader API documentation"
  55
  56 */
  57
  58
  59