doc/user/doxygen/doxfiles/index.dox

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