/*!
-@mainpage
+@mainpage SimGrid User Guide
<center>
\htmlonly
<table width="100%">
Grids.
- The official webpage is <a href="http://simgrid.gforge.inria.fr/">simgrid.gforge.inria.fr</a>.
- - The Frequently Asked Questions are <a href="http://simgrid.gforge.inria.fr/faq.html">here</a>.
+ - The Frequently Asked Questions for the latest version are <a href="http://simgrid.gforge.inria.fr/simgrid/latest/doc/FAQ.html">here</a>.
- The development webpage is <a href="https://gforge.inria.fr/projects/simgrid//">gforge.inria.fr/projects/simgrid</a>.
- The user mailing list is <simgrid-user@lists.gforge.inria.fr>
- - The SimGrid software package can be downloaded from <a href="http://simgrid.gforge.inria.fr/download.php">here</a>.
+ - The SimGrid software package can be downloaded from <a href="http://simgrid.gforge.inria.fr/download.html">here</a>.
<br>
<hr>
-\section overview Overview of the toolkit components
+\section ug_overview Overview of the toolkit components
As depicted by the following diagram, the SimGrid toolkit is basically
three-layered (click on the picture to jump to a specific component).
\endhtmlonly
-\subsection overview_envs Programmation environments layer
+\subsection ug_overview_envs Programmation environments layer
SimGrid provides several programmation environments built on top of a unique
simulation kernel. Each environment targets a specific audiance and
MPI) programming environment. Unfortunately, this work is still underway.
Check the \ref SMPI_API section for more information.
- - If you want to develop a real distributed application, then you may find
- <b>\ref GRAS_API</b> (Grid Reality And Simulation) useful. This is an API
- for the realization of distributed applications.
- \n\n
- Moreover, there is two implementations of this API: one on top of the
- SURF (allowing to develop and test your application within the comfort of
- the simulator) and another suited for deployment on real platforms
- (allowing the resulting application to be highly portable and extremely
- efficient).
- \n\n
- Even if you do not plan to run your code for real, you may want to switch
- to GRAS if you intend to use MSG in a very intensive way (e.g. for
- simulating a peer-to-peer environment).
- \n\n
- See the \ref GRAS_API section for more details.
-
If your favorite programming environment/model is not there (BSP,
components, OpenMP, etc.) is not represented in the SimGrid toolkit yet, you may
consider adding it. You should contact us first on the
<a href=http://lists.gforge.inria.fr/mailman/listinfo/simgrid-devel>SimGrid
developers mailing list</a>, though.
-\subsection overview_kernel Simulation kernel layer
+\subsection ug_overview_kernel Simulation kernel layer
The core functionnalities to simulate a virtual platform are provided by a
module called <b>\ref SURF_API</b>. It is
See the \ref SURF_API section for more details.
-\subsection overview_fondation Base layer
+\subsection ug_overview_fondation Base layer
The base of the whole toolkit is constituted by the <b>\ref XBT_API
(eXtended Bundle of Tools)</b>.
See the \ref XBT_API section for more details.
-\subsection lucas_layer Tracing simulation
+\subsection ug_lucas_layer Tracing simulation
Finally, a transversal module allows you to trace your simulation. More documentation in the section \ref TRACE_doc
<br>
The SimGrid software package can be downloaded from
-<a href="http://simgrid.gforge.inria.fr/download.php">here</a>.<br>
+<a href="http://simgrid.gforge.inria.fr/download.html">here</a>.<br>
If you are interested in the history of SimGrid and in current and planned development,
you can find out more <a href="http://simgrid.gforge.inria.fr/history.html">here</a>.
</center>
\endhtmlonly
-/**
-@defgroup SimGrid_User_Guide SimGrid User Guide
- @{ */
- /** @defgroup SimGrid_install Install */
- /** @defgroup SimGrid_options Options and configuration */
- /** @defgroup SimGrid_pls Packet-level simulation */
- /** @defgroup SimGrid_pf Platform description */
- /** @defgroup SimGrid_tracing Tracing */
- /** @defgroup MSG_User_Guide MSG User Guide */
- /** @defgroup SIMDAG_User_Guide SIMDAG User Guide */
- /** @defgroup GRAS_User_Guide GRAS User Guide */
- /** @defgroup SMPI_User_Guide SMPI User Guide */
- /** @defgroup AMOK_User_Guide AMOK User Guide */
- /** @defgroup XBT_User_Guide XBT User Guide */
- /** @defgroup Advanced_User_Guide Advanced User Guide */
-/** @{ */
- /** @defgroup SIMIX_User_Guide SIMIX User Guide: writing your own model */
-
-/** @} */
-/** @} */
*/
