From 0c380cf9a7fd73fdc9c986cccf2b0ee0b85368b8 Mon Sep 17 00:00:00 2001 From: mquinson Date: Tue, 6 Dec 2005 20:06:39 +0000 Subject: [PATCH] Reorder: first the programming environment, then the internals git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@1869 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- doc/index.doc | 64 ++++++++++++++++++++++++++------------------------- 1 file changed, 33 insertions(+), 31 deletions(-) diff --git a/doc/index.doc b/doc/index.doc index 5ffe4d9754..c7def678e9 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -50,7 +50,7 @@ this page. It is organized as follow: - \ref overview : Presentation of the toolkit, of each of its components and of their interactions. - \ref people : Who is behind this project. - - \ref publications : Some articles providing more details about the + - \ref publis : Some articles providing more details about the SimGrid toolkit or using and validating it.
@@ -70,37 +70,13 @@ three-layered (click on the picture to jump to a specific component). \endhtmlonly -\subsection overview_fondation Base layer - -The base of the whole toolkit is constituted by the \ref XBT_API -(eXtended Bundle of Tools). - -It is a portable library providing some grounding features such as \ref -XBT_log, \ref XBT_ex and \ref XBT_config. XBT also encompass -the following convenient datastructures: \ref XBT_dynar, \ref XBT_fifo, \ref -XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag. - -See the \ref XBT_API section for more details. - -\subsection overview_kernel Simulation kernel layer - -The core functionnalities to simulate a virtual platform are provided by a -module called \ref SURF_API ("that's historical, my friend"). It is -very low-level and is not intended to be used as such by end-users. Instead, -it serve as a basis for the higher level layer. - -SURF main features are a fast max-min linear solver and the ability to -change transparently the model used to describe the platform. This greatly -eases the comparison of the several models existing in the litterature. - -See the \ref SURF_API section for more details. - \subsection overview_envs Programmation environments layer -This simulation kernel is used to build several programmation environments. -Each of them target a specific audiance and constitute a different paradigm. -To choose which of them you want to use, you have to think about what you -want to do and what would be the result of your work. +SimGrid provides several programmation environments built on top of a uniq +simulation kernel. Each environment targets a specific audiance and +constitutes a different paradigm. To choose which of them you want to use, +you have to think about what you want to do and what would be the result of +your work. - If you want to study a theoritical problem and compare several heuristics, you probably want to try \ref MSG_API (yet another @@ -132,11 +108,37 @@ want to do and what would be the result of your work. See the \ref GRAS_API section for more details. If your favorite programming environment/model is not there (BSP, -components, etc.) is not represented in the SimGrid toolkit yet, you may +components, DAG, 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 + +The core functionnalities to simulate a virtual platform are provided by a +module called \ref SURF_API ("that's historical, my friend"). It is +very low-level and is not intended to be used as such by end-users. Instead, +it serve as a basis for the higher level layer. + +SURF main features are a fast max-min linear solver and the ability to +change transparently the model used to describe the platform. This greatly +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 + +The base of the whole toolkit is constituted by the \ref XBT_API +(eXtended Bundle of Tools). + +It is a portable library providing some grounding features such as \ref +XBT_log, \ref XBT_ex and \ref XBT_config. XBT also encompass +the following convenient datastructures: \ref XBT_dynar, \ref XBT_fifo, \ref +XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag. + +See the \ref XBT_API section for more details. + + Any question, remark or suggestion are welcome on the SimGrid users mailing list. -- 2.20.1