doc/doxygen/module-index.doc

   1 /** \defgroup SMPI_API      SMPI
   2     \brief Programming environment for the simulation of MPI applications
   3 */
   4
   5 /**
   6 @defgroup XBT_API      XBT
   7 @brief The core toolbox of SimGrid, containing useful datatypes and friends
   8 */
   9
  10 /**
  11 @defgroup TRACE_API TRACE
  12 @brief Tracing mechanism and its functions.
  13
  14 SimGrid can trace the resource (of hosts and links) utilization using
  15 any of its programming interfaces (MSG, SimDAG and SMPI). This means
  16 that the tracing will register how much power is used for each host
  17 and how much bandwidth is used for each link of the platform.
  18
  19 The idea of the tracing facilities is to give SimGrid users to
  20 possibility to classify MSG and SimDAG tasks by category, tracing the
  21 platform utilization (hosts and links) for each of the categories.
  22 The API enables the declaration of categories and a function to
  23 associate them to the tasks (MSG and SD). The tasks that are not
  24 classified according to a category are not traced. If no categories
  25 are specified, simulations can still be traced using a special
  26 parameter in the command line (see \ref tracing for details).
  27 */
  28
  29
  30 /** \defgroup SIMIX_API      SIMIX
  31     \brief POSIX-like interface for building simulation
  32
  33     This is a developer-level interface that should be useful only if you
  34     plan to design a new interface for SimGrid.
  35 */
  36
  37
  38
  39 /**
  40 @defgroup SURF_API SURF
  41 @brief Internal kernel of all the simulators used in SimGrid, and associated models.
  42
  43 SURF provides the core functionnalities to simulate a virtual
  44 platform. It is very low-level and is not intended to be used by end
  45 users, but rather to serve as a basis for higher-level simulators. Its
  46 interfaces are not frozen (and probably never will be), and the
  47 structure emphasis on performance over ease of use. This module
  48 contains the platform models. If you need a model that is not encoded
  49 yet, please come to the devel mailing list so that we can discuss on
  50 the feasibility of your idea.
  51
  52 Please note that as it is not really intended for public use, this
  53 module is only partially documented.
  54 */
  55
  56
  57