doc/modules.doc

   1 /**
   2   \defgroup SimGrid_API  SimGrid modules */
   3
   4 /** \defgroup XBT_API      XBT
   5     \ingroup SimGrid_API
   6     \brief The core toolbox of SimGrid, containing usefull datatypes,
   7            portability support and so on.
   8
   9 */
  10
  11 /** \defgroup SURF_API       SURF
  12     \ingroup SimGrid_API
  13     \brief Kernel of all the simulators used in SimGrid, and associated models.
  14
  15       SURF provides the core functionnalities to simulate a virtual
  16       platform. It is very low-level and is not intended to be used as
  17       such but rather to serve as a basis for higher-level simulators.
  18       We're still working on it and the structure is a little bit
  19       complex. So we'll document it only when we'll be completely satisfied of
  20       the way it is organized.
  21
  22       It is where platform models are encoded. If you need a model that is not
  23       encoded yet, please tell me (<arnaud.legrand@imag.fr>) and we'll
  24       see if it is feasible or not (hopefully it should be but who knows).
  25
  26       Please note that as it is not really intended for public use,
  27       this module is only partially documented.
  28 */
  29
  30 /** \defgroup MSG_API      MSG
  31     \ingroup SimGrid_API
  32     \brief Simple programming environment
  33
  34       MSG was the first distributed programming environment provided within
  35       SimGrid. While almost realistic, it remains quite simple (simplistic?).
  36
  37       \section MSG_who Who should use this (and who shouldn't)
  38
  39       You should use this module if you want to study some heuristics for a
  40       given problem you don't really want to implement. If you want to get a
  41       real implementation of your solution, have a look at the \ref GRAS_API
  42       programming environment. If you want to study an existing MPI program,
  43       have a look at the \ref SMPI_API one. If none of those programming
  44       environments fits your needs, you may consider implementing your own
  45       directly on top of \ref SURF_API (but you probably want to contact us
  46       before).
  47 */
  48
  49 /** \defgroup GRAS_API      GRAS
  50     \ingroup SimGrid_API
  51     \brief Realistic programming environment (Grid Reality And Simulation)
  52
  53     GRAS provides a complete API to implement distributed application on top
  54     of heterogeneous plateforms. In addition to the SimGrid implementation
  55     of this interface (allowing you to work on your application within the
  56     comfort of the simulator), an implementation suited to real platforms is
  57     also provided (allowing you to really use your application once you're
  58     done with developing it).
  59
  60     GRAS thus constitute a complete grid application developement framework,
  61     encompassing both developer helping tools (the simulator and associated
  62     tools) and an efficient while portable execution runtime.
  63
  64     \section GRAS_who Who should use this (and who shouldn't)
  65
  66     You should use this programming environment if you want to develop real
  67     applications, ie if the final result of your work is a program which
  68     may eventually be distributed.
  69     If you just want to study some heuristics for a given problem you don't
  70     want to implement really (ie, if your result would be a theorem), have a
  71     look at the \ref MSG_API one.
  72     If you want to study an existing MPI program, have a look at the
  73     \ref SMPI_API one.
  74     If none of those programming environments fits your needs, you may
  75     consider implementing your own directly on top of \ref SURF_API (but you
  76     probably want to contact us before).
  77 */
  78
  79 /** \defgroup AMOK_API AMOK
  80     \ingroup SimGrid_API
  81     \brief Distributed toolkit built over \ref GRAS_API (Advanced Metacomputing Overlay Kit)
  82
  83     AMOK provides several tools useful to most applications built on top of GRAS,
  84     but yet not belonging to GRAS itself. It is planned that those modules will be
  85     changed to real plugins one day, allowing users to load only the needed parts at
  86     run time. For now, they live in another library against which you should link your
  87     programs explicitly.
  88 */
  89
  90 /** \defgroup SMPI_API      SMPI
  91     \ingroup SimGrid_API
  92     \brief Programming environment for the simulation of MPI applications
  93
  94     Once implemented, this programming environment will allow you to study
  95     within the simulator any MPI application without having to modify them
  96     for that. In other words, it will constitute an emulation solution for
  97     parallel codes.
  98
  99     \section SMPI_who Who should use this (and who shouldn't)
 100
 101     You should use this programming environment of the SimGrid suite if you
 102     want to study existing MPI applications.
 103     If you want to work on a distributed application, have a look at the
 104     \ref GRAS_API environment.
 105     If you want to study some heuristics for a given problem (and if your
 106     goal is to produce theorems, not code), have a look at the \ref MSG_API
 107     environment.
 108     If none of those programming environments fits your needs, you may
 109     consider implementing your own directly on top of \ref SURF_API (but you
 110     probably want to contact us before).
 111
 112  */