The skeleton now has to be fleshed
26 files changed:
doxygen/getting_started.doc \
doxygen/install.doc \
doxygen/application.doc \
doxygen/getting_started.doc \
doxygen/install.doc \
doxygen/application.doc \
- doxygen/tutorial.doc \
- doxygen/examples.doc \
- doxygen/platform.doc \
+ doxygen/bindings.doc \
+ doxygen/platform.doc \
+ doxygen/models.doc \
+ doxygen/pls.doc \
+ doxygen/scenario.doc \
doxygen/deployment.doc \
doxygen/options.doc \
doxygen/deployment.doc \
doxygen/options.doc \
- doxygen/help.doc \
- doxygen/advanced.doc \
- doxygen/pls.doc \
- doxygen/bindings.doc \
+ doxygen/outcomes.doc \
+ doxygen/outcomes_logs.doc \
+ doxygen/outcomes_vizu.doc \
+ doxygen/outcomes_MC.doc \
+ doxygen/tutorial.doc \
+ doxygen/examples.doc \
+ doxygen/uhood.doc \
doxygen/inside.doc \
doxygen/inside_doxygen.doc \
doxygen/inside_extending.doc \
doxygen/inside_cmake.doc \
doxygen/inside_tests.doc \
doxygen/inside_release.doc \
doxygen/inside.doc \
doxygen/inside_doxygen.doc \
doxygen/inside_extending.doc \
doxygen/inside_cmake.doc \
doxygen/inside_tests.doc \
doxygen/inside_release.doc \
- doxygen/contributing.doc \
- doxygen/tracing.doc \
+ doxygen/community.doc \
+ doxygen/community_contact.doc \
+ doxygen/community_contributing.doc \
+ doxygen/community_extend.doc \
+ doxygen/community_giveback.doc \
doxygen/FAQ.doc \
doxygen/module-msg.doc \
doxygen/module-sd.doc \
doxygen/FAQ.doc \
doxygen/module-msg.doc \
doxygen/module-sd.doc \
+++ /dev/null
-/*! @page advanced Advanced Topics
-
-This page does not exist yet. Writing an acceptable user documentation
-is already difficult, but writing a good documentation for advanced
-users is near to impossible. In the meanwhile, please refer to the
-tutorials on the project web page, looking for the "SimGrid::Internals"
-tutorials.
-
-- @subpage bindings
-- @subpage pls
-- @subpage tracing
-
-*/
--- /dev/null
+/**
+@page community The SimGrid Community
+
+TBD
+
+*/
\ No newline at end of file
-/*! @page contact Contact us
+/*! @page community_contact Contact us
If you are new to the SimGrid framework, you should first strive at
reading the current documentation and studying the provided examples.
If you are new to the SimGrid framework, you should first strive at
reading the current documentation and studying the provided examples.
--- /dev/null
+/**
+@page community_extend Extending SimGrid and Contributed Code
+
+TBD
+
+ - Contribute a Platform file
+ - Contribute a Plugin
+ - Contribute a Routing Schema
+
+ - the current Contributed section from the website
+
+*/
\ No newline at end of file
-/*! @page contributing Giving back to SimGrid
+/*! @page community_giveback Giving back to SimGrid
- @subpage install
- @subpage application
- @subpage MSG_API
- @subpage install
- @subpage application
- @subpage MSG_API
+ - @subpage SD_API
+ - @subpage SMPI_API
+ - @subpage bindings
+- @subpage platform
+ - @subpage models
+ - @subpage pls
+- @subpage scenario
- @subpage deployment
- @subpage options
- @subpage deployment
- @subpage options
+- @subpage outcomes
+ - @subpage outcomes_logs
+ - @subpage outcomes_vizu
+ - @subpage outcomes_MC
+- Use Cases
+ - Energy, Clouds
+ - Scalability Tweaks
- @subpage tutorial
- @subpage examples
- @subpage tutorial
- @subpage examples
-- @subpage advanced
- - @ref bindings
- - @ref pls
- - @ref tracing
-- @subpage inside
- - @ref inside_tests
- - @ref inside_doxygen
- - @ref inside_extending
- - @ref inside_cmake
- - @ref inside_release
-- @subpage contributing
- - @ref contact
+- @subpage uhood
+ - Simulating Resource Sharing
+ - Context Switching
+ - @subpage inside
+- @subpage community
+ - @subpage community_contact
+ - @subpage community_giveback
+ - @subpage community_extend
-/*! @page inside SimGrid Developer Guide
+/*! @page inside Coding Standard and Project Architecture
-This page does not exist yet, sorry. We are currently refurbishing the
-user documentation -- the internal documentation will follow (FIXME).
There is two main things you want to know about the internals of
SimGrid. First, you need to understand the component organization, as
There is two main things you want to know about the internals of
SimGrid. First, you need to understand the component organization, as
@ref contributing_bugs "you should report".\n
If your system is actually not supported, you should compile your
own jarfile @ref install_src "by compiling SimGrid" on your
@ref contributing_bugs "you should report".\n
If your system is actually not supported, you should compile your
own jarfile @ref install_src "by compiling SimGrid" on your
- machine. If you feel so, @ref contact "contact us" so that we add
+ machine. If you feel so, @ref community_contact "contact us" so that we add
your architecture to the list.
- **Library not found: boost-context**.\n
your architecture to the list.
- **Library not found: boost-context**.\n
The drawback of MinGW-64 is that the produced DLL are not compatible
with MS Visual C. <a href="http://clang.llvm.org/docs/MSVCCompatibility.html">clang-cl</a>
sounds promising to fix this. If you get something working, please
The drawback of MinGW-64 is that the produced DLL are not compatible
with MS Visual C. <a href="http://clang.llvm.org/docs/MSVCCompatibility.html">clang-cl</a>
sounds promising to fix this. If you get something working, please
+@ref community_contact "tell us".
@subsubsection install_src_32bits 32 bits Builds on Multi-arch Linux
@subsubsection install_src_32bits 32 bits Builds on Multi-arch Linux
--- /dev/null
+/**
+@page models SimGrid Models
+
+TBD
+
+ - Main existing models (contention, cste, LM07)
+ - Main concepts (Routing, LMM) + link to the papers
+ - How to switch on the command line
+
+*/
\ No newline at end of file
-/** \defgroup SMPI_API SMPI
- \brief Programming environment for the simulation of MPI applications
-*/
-
/**
@defgroup XBT_API XBT
@brief The core toolbox of SimGrid, containing useful datatypes and friends
/**
@defgroup XBT_API XBT
@brief The core toolbox of SimGrid, containing useful datatypes and friends
associate them to the tasks (MSG 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
associate them to the tasks (MSG 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 tracing for details).
+parameter in the command line (see \ref outcomes_vizu for details).
-@defgroup MSG_API MSG: Simple API for CSP Algorithms
+@defgroup MSG_API MSG: Simulate CSP Algorithms
@brief Simple programming environment
MSG is a simple API to write algorithms organized with Concurrent
@brief Simple programming environment
MSG is a simple API to write algorithms organized with Concurrent
-/** @defgroup SD_API SimDag for DAG applications
- @brief Programming environment for DAG applications
+/**
+@defgroup SD_API SimDag: Simulate DAG algorithms
+@brief Programming environment for DAG applications
SimDag provides functionnalities to simulate parallel task scheduling
arranged in DAGs (Direct Acyclic Graphs). Only centralized algorithms
SimDag provides functionnalities to simulate parallel task scheduling
arranged in DAGs (Direct Acyclic Graphs). Only centralized algorithms
-/** @addtogroup SMPI_API
-
+/**
+@defgroup SMPI_API SMPI: Semulate real MPI applications
+@brief Programming environment for the simulation of MPI applications
+
This programming environment enables the study of MPI application by
emulating them on top of the SimGrid simulator. This is particularly
interesting to study existing MPI applications within the comfort of
This programming environment enables the study of MPI application by
emulating them on top of the SimGrid simulator. This is particularly
interesting to study existing MPI applications within the comfort of
- \ref TRACE_mark
- \ref TRACE_user_variables
- \ref TRACE_mark
- \ref TRACE_user_variables
-\defgroup TRACE_category Tracing categories
-\ingroup TRACE_API
-\brief Functions to declare tracing categories.
+@{
+
+ @defgroup TRACE_category Tracing categories
+ @brief Functions to declare tracing categories.
-\defgroup TRACE_mark Tracing marks
-\ingroup TRACE_API
-\brief Functions to declare and create tracing marks.
+ @defgroup TRACE_mark Tracing marks
+ @brief Functions to declare and create tracing marks.
-\defgroup TRACE_user_variables Tracing user variables
-\ingroup TRACE_API
-\brief Functions to declare and define user variables associated to resources.
+ @defgroup TRACE_user_variables Tracing user variables
+ @brief Functions to declare and define user variables associated to resources.
+
+@}
*/
\ No newline at end of file
*/
\ No newline at end of file
\section options_tracing Configuring the tracing subsystem
\section options_tracing Configuring the tracing subsystem
-The \ref tracing "tracing subsystem" can be configured in several
+The \ref outcomes_vizu "tracing subsystem" can be configured in several
different ways depending on the nature of the simulator (MSG, SimDag,
SMPI) and the kind of traces that need to be obtained. See the \ref
tracing_tracing_options "Tracing Configuration Options subsection" to
different ways depending on the nature of the simulator (MSG, SimDag,
SMPI) and the kind of traces that need to be obtained. See the \ref
tracing_tracing_options "Tracing Configuration Options subsection" to
--- /dev/null
+/**
+@page outcomes Simulation Outcomes
+
+TBD
+
+ - Logs
+ - Visualisation and post-mortem statistics analysis
+ - Model-Checking
+
+*/
\ No newline at end of file
--- /dev/null
+/**
+@page outcomes_MC Model-Checking
+
+TBD
+
+*/
\ No newline at end of file
--- /dev/null
+/**
+@page outcomes_logs Simulation Logging
+
+TBD
+
+*/
\ No newline at end of file
-/*! \page tracing Tracing Simulations
+/*! \page outcomes_vizu Visualization and Statistical Analysis
+SimGrid comes with an extensive support to trace and register what
+happens during the simulation, so that it can be either visualized or
+statistically analysed after the simulation.
-Tracing is widely used to observe and understand the behavior of
+This tracing is widely used to observe and understand the behavior of
parallel applications and distributed algorithms. Usually, this is
done in a two-step fashion: the user instruments the application and
the traces are analyzed after the end of the execution. The analysis
parallel applications and distributed algorithms. Usually, this is
done in a two-step fashion: the user instruments the application and
the traces are analyzed after the end of the execution. The analysis
--- /dev/null
+/**
+@page scenario Describing the experimental scenario
+
+TBD
+
+Main concepts:
+
+ - Deployment file
+ - Availability and state profiles
+ - Reproducible random number generation
+ - Command line options, in particular on the model switching
+
+*/
\ No newline at end of file
--- /dev/null
+/*! @page uhood Under the Hood
+
+TBD
+
+ - Simulation Loop, LMM, sharing -> papers
+ - Context Switching, privatization -> papers
+ - @subpage inside
+
+*/
until all activities in a given set have completed.
- <b>Waiting for the first completed communication in a set</b>.
until all activities in a given set have completed.
- <b>Waiting for the first completed communication in a set</b>.
- @ref examples/msg/async-waitall/async-waitany.c\n
+ @ref examples/msg/async-waitany/async-waitany.c\n
The @ref MSG_comm_waitany function is useful when you want to block
until one activity of the set completes, no matter which terminates
first.
The @ref MSG_comm_waitany function is useful when you want to block
until one activity of the set completes, no matter which terminates
first.
@example examples/msg/async-wait/async-wait.c
@example examples/msg/async-waitall/async-waitall.c
@example examples/msg/async-wait/async-wait.c
@example examples/msg/async-waitall/async-waitall.c
-@example examples/msg/async-waitall/async-waitany.c
+@example examples/msg/async-waitany/async-waitany.c
@example examples/msg/process-create/process-create.c
@example examples/msg/process-suspend/process-suspend.c
@example examples/msg/process-create/process-create.c
@example examples/msg/process-suspend/process-suspend.c
* task category. Tasks that do not belong to a category are not traced. The color for the category that is being
* declared is random. This function has no effect if a category with the same name has been already declared.
*
* task category. Tasks that do not belong to a category are not traced. The color for the category that is being
* declared is random. This function has no effect if a category with the same name has been already declared.
*
- * See \ref tracing for details on how to trace the (categorized) resource utilization.
+ * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
*
* \param category The name of the new tracing category to be created.
*
*
* \param category The name of the new tracing category to be created.
*
* So, to specify a red color, pass "1 0 0" as color parameter. A light-gray color can be specified using "0.7 0.7 0.7"
* as color. This function has no effect if a category with the same name has been already declared.
*
* So, to specify a red color, pass "1 0 0" as color parameter. A light-gray color can be specified using "0.7 0.7 0.7"
* as color. This function has no effect if a category with the same name has been already declared.
*
- * See \ref tracing for details on how to trace the (categorized) resource utilization.
+ * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
*
* \param category The name of the new tracing category to be created.
*
* \param category The name of the new tracing category to be created.
- * \param color The color of the category (see \ref tracing to
+ * \param color The color of the category (see \ref outcomes_vizu to
* know how to correctly specify the color)
*
* \see MSG_task_set_category, SD_task_set_category
* know how to correctly specify the color)
*
* \see MSG_task_set_category, SD_task_set_category
* This function should be used to get categories that were already declared with #TRACE_category or with
* #TRACE_category_with_color.
*
* This function should be used to get categories that were already declared with #TRACE_category or with
* #TRACE_category_with_color.
*
- * See \ref tracing for details on how to trace the (categorized) resource utilization.
+ * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
*
* \return A dynar with the declared categories, must be freed with xbt_dynar_free.
*
*
* \return A dynar with the declared categories, must be freed with xbt_dynar_free.
*
* parameter category must contain a category that was previously declared with the function #TRACE_category
* (or with #TRACE_category_with_color).
*
* parameter category must contain a category that was previously declared with the function #TRACE_category
* (or with #TRACE_category_with_color).
*
- * See \ref tracing for details on how to trace the (categorized) resource utilization.
+ * See \ref outcomes_vizu for details on how to trace the (categorized) resource utilization.
*
* \param task the task that is going to be categorized
* \param category the name of the category to be associated to the task
*
* \param task the task that is going to be categorized
* \param category the name of the category to be associated to the task
doc/triva-time_interval.svg
doc/doxygen/FAQ.doc
doc/triva-time_interval.svg
doc/doxygen/FAQ.doc
- doc/doxygen/advanced.doc
doc/doxygen/application.doc
doc/doxygen/bindings.doc
doc/doxygen/application.doc
doc/doxygen/bindings.doc
- doc/doxygen/contributing.doc
+ doc/doxygen/community.doc
+ doc/doxygen/community_contact.doc
+ doc/doxygen/community_extend.doc
+ doc/doxygen/community_giveback.doc
doc/doxygen/deployment.doc
doc/doxygen/deployment.doc
+ doc/doxygen/examples.doc
doc/doxygen/footer.html
doc/doxygen/getting_started.doc
doc/doxygen/header.html
doc/doxygen/footer.html
doc/doxygen/getting_started.doc
doc/doxygen/header.html
doc/doxygen/index.doc
doc/doxygen/inside.doc
doc/doxygen/inside_tests.doc
doc/doxygen/index.doc
doc/doxygen/inside.doc
doc/doxygen/inside_tests.doc
doc/doxygen/inside_release.doc
doc/doxygen/install.doc
doc/doxygen/tutorial.doc
doc/doxygen/inside_release.doc
doc/doxygen/install.doc
doc/doxygen/tutorial.doc
doc/doxygen/module-msg.doc
doc/doxygen/module-sd.doc
doc/doxygen/module-simix.doc
doc/doxygen/module-msg.doc
doc/doxygen/module-sd.doc
doc/doxygen/module-simix.doc
doc/doxygen/module-xbt.doc
doc/doxygen/module-index.doc
doc/doxygen/options.doc
doc/doxygen/module-xbt.doc
doc/doxygen/module-index.doc
doc/doxygen/options.doc
+ doc/doxygen/outcomes.doc
+ doc/doxygen/outcomes_logs.doc
+ doc/doxygen/outcomes_MC.doc
+ doc/doxygen/outcomes_vizu.doc
doc/doxygen/platform.doc
doc/doxygen/pls.doc
doc/doxygen/platform.doc
doc/doxygen/pls.doc
+ doc/doxygen/scenario.doc
doc/doxygen/stylesheet.css
doc/doxygen/stylesheet.css
- doc/doxygen/tracing.doc
- doc/doxygen/examples.doc
doc/manpage/smpicc.1
doc/manpage/smpicxx.1
doc/manpage/smpicc.1
doc/manpage/smpicxx.1
