Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
New function: gras_msg_wait_ext (for a finer control of accepted messages); introduce...
[simgrid.git] / doc / modules.doc
index 40ea7f2..1c606f8 100644 (file)
@@ -1,16 +1,24 @@
 /** 
-  \defgroup SimGrid_API  API of SimGrid */
+  \defgroup SimGrid_API  SimGrid modules */
 
 /** \defgroup XBT_API      XBT
-       \ingroup SimGrid_API
-       \brief The core toolbox of SimGrid, containing usefull datatypes,
-       portability support and so on.
+    \ingroup SimGrid_API
+    \brief The core toolbox of SimGrid, containing usefull datatypes,
+           portability support and so on.
+
+  <center><table><tr><td><b>Top</b>        <td> [\ref index]
+                 <tr><td>   Other modules  <td> [\ref SURF_API] [\ref MSG_API] [\ref GRAS_API] [\ref AMOK_API] [\ref SMPI_API] 
+                 <tr><td><b>Down</b>       <td> [\ref XBT_syscall] </table></center>
 */
 
 /** \defgroup SURF_API       SURF
     \ingroup SimGrid_API
     \brief Kernel of all the simulators used in SimGrid, and associated models.
  
+  <center><table><tr><td><b>Top</b>     <td> [\ref index]
+                 <tr><td><b>Related modules</b> <td> [\ref XBT_API]   
+                 <tr><td>   Other modules      <td> [\ref MSG_API] [\ref GRAS_API] [\ref AMOK_API] [\ref SMPI_API] </table></center>
+
       SURF provides the core functionnalities to simulate a virtual
       platform. It is very low-level and is not intended to be used as
       such but rather to serve as a basis for higher-level simulators.
     \ingroup SimGrid_API
     \brief Simple programming environment 
   
+  <center><table><tr><td><b>Top</b>     <td> [\ref index]
+                 <tr><td><b>Related modules</b> <td> [\ref XBT_API]   
+                 <tr><td>   Other modules      <td> [\ref SURF_API] [\ref GRAS_API] [\ref AMOK_API] [\ref SMPI_API] </table></center>
+
       MSG was the first distributed programming environment provided within
       SimGrid. While almost realistic, it remains quite simple (simplistic?).
 
       \section MSG_who Who should use this (and who shouldn't)
       
-      You should use this model if you want to study some heuristics for a
+      You should use this module if you want to study some heuristics for a
       given problem you don't really want to implement. If you want to get a
       real implementation of your solution, have a look at the \ref GRAS_API 
       programming environment. If you want to study an existing MPI program,
       directly on top of \ref SURF_API (but you probably want to contact us
       before). 
 */
-/**     \addtogroup m_datatypes_management
-        \ingroup MSG_API  */
-/**     \addtogroup m_process_management
-        \ingroup MSG_API  */
-/**     \addtogroup m_host_management
-        \ingroup MSG_API  */
-/**     \addtogroup m_task_management
-        \ingroup MSG_API  */
-/**     \addtogroup msg_gos_functions
-        \ingroup MSG_API  */
-/**     \addtogroup m_channel_management
-        \ingroup MSG_API  */
-/**     \addtogroup msg_easier_life
-        \ingroup MSG_API  */
-/**     \addtogroup msg_simulation
-        \ingroup MSG_API  */
-
 
 /** \defgroup GRAS_API      GRAS
     \ingroup SimGrid_API
     \brief Realistic programming environment (Grid Reality And Simulation)
   
-    GRAS provide a complete API to implement distributed application on top
+  <center><table><tr><td><b>Top</b>     <td> [\ref index]
+                 <tr><td><b>Related modules</b> <td> [\ref XBT_API]   [\ref AMOK_API]
+                 <tr><td>   Other modules       <td> [\ref SURF_API]  [\ref MSG_API] [\ref SMPI_API] 
+                 <tr><td><b>Down</b>            <td> [\ref GRAS_dd]   </table></center>
+
+    GRAS provides a complete API to implement distributed application on top
     of heterogeneous plateforms. In addition to the SimGrid implementation
     of this interface (allowing you to work on your application within the
     comfort of the simulator), an implementation suited to real platforms is
     probably want to contact us before).
 */
 
+/** \defgroup AMOK_API AMOK
+    \ingroup SimGrid_API
+    \brief Distributed toolkit built over \ref GRAS_API (Advanced Metacomputing Overlay Kit)
+
+  <center><table><tr><td><b>Top</b>     <td> [\ref index]
+                 <tr><td><b>Related modules</b> <td> [\ref XBT_API] [\ref GRAS_API]
+                 <tr><td>   Other modules      <td> [\ref SURF_API] [\ref MSG_API] [\ref SMPI_API] </table></center>
+
+    AMOK provides several tools useful to most applications built on top of GRAS, 
+    but yet not belonging to GRAS itself. It is planned that those modules will be 
+    changed to real plugins one day, allowing users to load only the needed parts at
+    run time. For now, they live in another library against which you should link your 
+    programs explicitly.
+*/
+
 /** \defgroup SMPI_API      SMPI
     \ingroup SimGrid_API
     \brief Programming environment for the simulation of MPI applications
   
+  <center><table><tr><td><b>Top</b>     <td> [\ref index]
+                 <tr><td><b>Related modules</b> <td> [\ref XBT_API] 
+                 <tr><td>   Other modules       <td> [\ref SURF_API] [\ref GRAS_API] [\ref AMOK_API] [\ref MSG_API] </table></center>
+
     Once implemented, this programming environment will allow you to study
     within the simulator any MPI application without having to modify them
     for that. In other words, it will constitute an emulation solution for