doc/doxygen/modules.doc

   1 /**
   2 @defgroup MSG_API      MSG
   3 @brief Simple programming environment
   4
   5 */
   6
   7 /**
   8 @defgroup XBT_API      XBT
   9 @brief The core toolbox of SimGrid, containing usefull datatypes and friends
  10 */
  11
  12 /**
  13 @defgroup TRACE_API TRACE
  14 @brief Tracing mechanism and its functions.
  15
  16 SimGrid can trace the resource (of hosts and links) utilization using
  17 any of its programming interfaces (MSG, SimDAG and SMPI). This means
  18 that the tracing will register how much power is used for each host
  19 and how much bandwidth is used for each link of the platform.
  20
  21 The idea of the tracing facilities is to give SimGrid users to
  22 possibility to classify MSG and SimDAG tasks by category, tracing the
  23 platform utilization (hosts and links) for each of the categories.
  24 The API enables the declaration of categories and a function to
  25 associate them to the tasks (MSG and SD). The tasks that are not
  26 classified according to a category are not traced. If no categories
  27 are specified, simulations can still be traced using a special
  28 parameter in the command line (see \ref tracing for details).
  29 */
  30
  31
  32 /** \defgroup SIMIX_API      SIMIX
  33     \brief POSIX-like interface for building simulation
  34
  35     This is a developer-level interface that should be useful only if you
  36     plan to design a new interface for SimGrid.
  37 */
  38
  39
  40 /** \defgroup SMPI_API      SMPI
  41     \brief Programming environment for the simulation of MPI applications
  42 */
  43
  44
  45 /** \defgroup SD_API      SimDag
  46     \brief Programming environment for DAG applications
  47
  48     SimDag provides some functionnalities to simulate parallel task scheduling
  49     with DAGs models (Direct Acyclic Graphs).
  50     The old versions of SimGrid were based on DAGs. But the DAG part (named SG)
  51     was removed in SimGrid 3 because the new kernel (\ref SURF_API) was implemented. \ref SURF_API
  52     was much faster and more flexible than SG and did not use DAGs.
  53     SimDag is a new implementation of DAGs handling and it is built on top of \ref SURF_API.
  54
  55     \section SD_who Who should use this (and who shouldn't)
  56
  57     You should use this programming environment of the SimGrid suite if you want
  58     to study algorithms and heuristics with DAGs of parallel tasks.
  59     If you don't need to use DAGs for your simulation, have a look at the
  60     \ref MSG_API programming environment.
  61     If you want to study an existing MPI program, have a look at the
  62     \ref SMPI_API one.
  63     If none of those programming environments fits your needs, you may
  64     consider implementing your own directly on top of \ref SURF_API (but you
  65     probably want to contact us before).
  66
  67 */
  68
  69 /**
  70 @defgroup SURF_API SURF
  71 @brief Internal kernel of all the simulators used in SimGrid, and associated models.
  72
  73 SURF provides the core functionnalities to simulate a virtual
  74 platform. It is very low-level and is not intended to be used by end
  75 users, but rather to serve as a basis for higher-level simulators. Its
  76 interface are not frozen (and will probably never be), and the
  77 structure emphasis on performance over ease of use. This module
  78 contains the platform models. If you need a model that is not encoded
  79 yet, please come to the devel mailing list so that we can discuss on
  80 the feasibility of your idea.
  81
  82 Please note that as it is not really intended for public use, this
  83 module is only partially documented.
  84 */
  85
  86
  87