doc/doxygen/module-index.doc

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