X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/66a04c68ab4c5135a15505ca5484eb8c4e7cdca6..8340b9ca34a27bc19136607105d3ec1fe15c91db:/doc/user_guide/doxygen/index.doc diff --git a/doc/user_guide/doxygen/index.doc b/doc/user_guide/doxygen/index.doc index 084e6235b3..883fc8d4a9 100644 --- a/doc/user_guide/doxygen/index.doc +++ b/doc/user_guide/doxygen/index.doc @@ -1,5 +1,5 @@ /*! -@mainpage +@mainpage SimGrid User Guide
\htmlonly @@ -31,12 +31,12 @@ Grids. - The Frequently Asked Questions are here. - The development webpage is gforge.inria.fr/projects/simgrid. - The user mailing list is - - The SimGrid software package can be downloaded from here. + - The SimGrid software package can be downloaded from here.

-\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). @@ -52,7 +52,7 @@ 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 @@ -73,29 +73,13 @@ your work. 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 - \ref GRAS_API (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 SimGrid developers mailing list, 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 \ref SURF_API. It is @@ -108,7 +92,7 @@ eases the comparison of the several models existing in the litterature. 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 \ref XBT_API (eXtended Bundle of Tools). @@ -121,13 +105,13 @@ XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag. 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
The SimGrid software package can be downloaded from -here.
+here.
If you are interested in the history of SimGrid and in current and planned development, you can find out more here. @@ -144,25 +128,5 @@ mailing list. \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 */ - -/** @} */ -/** @} */ */