2 \defgroup SimGrid_API API of SimGrid */
4 /** \defgroup XBT_API XBT
6 \brief The core toolbox of SimGrid, containing usefull datatypes,
7 portability support and so on.
10 /** \defgroup SURF_API SURF
12 \brief Kernel of all the simulators used in SimGrid, and associated models.
14 SURF provides the core functionnalities to simulate a virtual
15 platform. It is very low-level and is not intended to be used as
16 such but rather to serve as a basis for higher-level simulators.
17 We're still working on it and the structure is a little bit
18 complex. So we'll document it only when we'll be completely satisfied of
19 the way it is organized.
21 It is where platform models are encoded. If you need a model that is not
22 encoded yet, please tell me (<arnaud.legrand@imag.fr>) and we'll
23 see if it is feasible or not (hopefully it should be but who knows).
25 Please note that as it is not really intended for public use,
26 this module is only partially documented.
29 /** \defgroup MSG_API MSG
31 \brief Simple programming environment
33 MSG was the first distributed programming environment provided within
34 SimGrid. While almost realistic, it remains quite simple (simplistic?).
36 \section MSG_who Who should use this (and who shouldn't)
38 You should use this model if you want to study some heuristics for a
39 given problem you don't really want to implement. If you want to get a
40 real implementation of your solution, have a look at the \ref GRAS_API
41 programming environment. If you want to study an existing MPI program,
42 have a look at the \ref SMPI_API one. If none of those programming
43 environments fits your needs, you may consider implementing your own
44 directly on top of \ref SURF_API (but you probably want to contact us
47 /** \addtogroup m_datatypes_management
49 /** \addtogroup m_process_management
51 /** \addtogroup m_host_management
53 /** \addtogroup m_task_management
55 /** \addtogroup msg_gos_functions
57 /** \addtogroup m_channel_management
59 /** \addtogroup msg_easier_life
61 /** \addtogroup msg_simulation
65 /** \defgroup GRAS_API GRAS
67 \brief Realistic programming environment (Grid Reality And Simulation)
69 GRAS provide a complete API to implement distributed application on top
70 of heterogeneous plateforms. In addition to the SimGrid implementation
71 of this interface (allowing you to work on your application within the
72 comfort of the simulator), an implementation suited to real platforms is
73 also provided (allowing you to really use your application once you're
74 done with developing it).
76 GRAS thus constitute a complete grid application developement framework,
77 encompassing both developer helping tools (the simulator and associated
78 tools) and an efficient while portable execution runtime.
80 \section GRAS_who Who should use this (and who shouldn't)
82 You should use this programming environment if you want to develop real
83 applications, ie if the final result of your work is a program which
84 may eventually be distributed.
85 If you just want to study some heuristics for a given problem you don't
86 want to implement really (ie, if your result would be a theorem), have a
87 look at the \ref MSG_API one.
88 If you want to study an existing MPI program, have a look at the
90 If none of those programming environments fits your needs, you may
91 consider implementing your own directly on top of \ref SURF_API (but you
92 probably want to contact us before).
95 /** \defgroup SMPI_API SMPI
97 \brief Programming environment for the simulation of MPI applications
99 Once implemented, this programming environment will allow you to study
100 within the simulator any MPI application without having to modify them
101 for that. In other words, it will constitute an emulation solution for
104 \section SMPI_who Who should use this (and who shouldn't)
106 You should use this programming environment of the SimGrid suite if you
107 want to study existing MPI applications.
108 If you want to work on a distributed application, have a look at the
109 \ref GRAS_API environment.
110 If you want to study some heuristics for a given problem (and if your
111 goal is to produce theorems, not code), have a look at the \ref MSG_API
113 If none of those programming environments fits your needs, you may
114 consider implementing your own directly on top of \ref SURF_API (but you
115 probably want to contact us before).