Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Convert some insider doc to sphinx, and remove obsolete bits from doxygen sources
[simgrid.git] / doc / doxygen / outcomes_vizu.doc
index f97248b..c8899ea 100644 (file)
@@ -1,3 +1,22 @@
+/**
+@defgroup TRACE_API TRACING
+@brief Gather data about your simulation for later analysis
+
+SimGrid can trace the resource (of hosts and links) utilization using
+any of its programming interfaces (S4U, SimDAG and SMPI). This means
+that the tracing will register how much power is used for each host
+and how much bandwidth is used for each link of the platform.
+
+The idea of the tracing facilities is to give SimGrid users to
+possibility to classify S4U and SimDAG tasks by category, tracing the
+platform utilization (hosts and links) for each of the categories.
+The API enables the declaration of categories and a function to
+associate them to the tasks (S4U and SD). The tasks that are not
+classified according to a category are not traced. If no categories
+are specified, simulations can still be traced using a special
+parameter in the command line (see @ref outcomes_vizu for details).
+*/
+
 /*! @page outcomes_vizu Visualization and Statistical Analysis
 
 SimGrid comes with an extensive support to trace and register what