docs/source/index.rst

   1 .. SimGrid documentation master file
   2
   3 The Modern Age of Computer Systems Simulation
   4 =============================================
   5
   6 SimGrid is a framework to simulate distributed computer systems. It can be used
   7 to either `assess abstract algorithms <usecase_simalgo>`_, or to `debug and
   8 profile real MPI applications <usecase_smpi>`_.
   9
  10 SimGrid is routinely used in studies on (data-)Grids,
  11 IaaS Clouds (:ref:`API <API_s4u_VirtualMachine>`, :ref:`examples <s4u_ex_clouds>`),
  12 Clusters, High Performance Computing (`🖹 <http://hal.inria.fr/hal-01415484>`_),
  13 Peer-to-Peer systems,
  14 Volunteer Computing (`🖹 <http://www.sciencedirect.com/science/article/pii/S1569190X17301028>`__)
  15 Fog Computing (`🖹 <http://ieeexplore.ieee.org/document/7946412/>`__),
  16 MapReduce (`🖹 <http://www.sciencedirect.com/science/article/pii/S0167819113000215>`__) and
  17 `much more <https://simgrid.org/Usages.html>`_.
  18
  19 The simulation models are **fast** (`🖹 <http://hal.inria.fr/hal-00650233>`__) and
  20 **highly scalable** (`🖹 <http://hal.inria.fr/inria-00602216/>`__) while
  21 **theoretically sound and experimentally assessed** (`🖹 <http://doi.acm.org/10.1145/2517448>`__).
  22 Most of the time, SimGrid is used to predict the performance (time and energy) of a
  23 given IT infrastructure, and it includes a prototypal model-checker to formally
  24 assess these systems.
  25
  26 Technically speaking, SimGrid is a library. It is neither a graphical
  27 interface nor a command-line simulator running user scripts. The
  28 interaction with SimGrid is done by writing programs with the exposed
  29 functions to build your own simulator. This can be done in C/C++, Python or Java,
  30 on Linux, Mac OSX or Windows (using the WSL).
  31
  32 SimGrid is a Free Software distributed under the LGPL-2.1 license. You are
  33 welcome to use, study, share and improve it, provided that your version are as
  34 free as ours. SimGrid is developed by a vivid community of users and developers.
  35 We hope that you will come and join us! SimGrid is the result of almost 20 years
  36 of research from several groups, both in France and in the U.S.A. It benefited
  37 of many funding from various research bodies.
  38
  39 SimGrid is a powerful tool, and this documentation will help you taking the best
  40 of it. Check its contents on the left. Each tutorial presents a classical use
  41 case, in a fast and practical manner. The user manual containts more
  42 throughfully information. In each part, the important concepts are concisely
  43 introduced, before the reference manual. SimGrid is also described in several
  44 `scientific papers <https://simgrid.org/Publications.html>`_.
  45
  46 Please report any documentation issue, including typos or unclear elements. You
  47 can even propose changes by clicking on the "Edit on FramaGit" button at the top
  48 of every page. Bugs in the code should be reported
  49 `on FramaGit <https://framagit.org/simgrid/simgrid/issues>`_
  50
  51
  52 .. TODO
  53 ..
  54 .. The webpage should be made light, graphical and nice looking.
  55
  56 .. toctree::
  57    :hidden:
  58    :maxdepth: 1
  59    :caption: Tutorials:
  60
  61         Simulating Algorithms <Tutorial_Algorithms.rst>
  62         Simulating MPI Applications <Tutorial_MPI_Applications.rst>
  63
  64 .. toctree::
  65    :hidden:
  66    :maxdepth: 2
  67    :caption: User Manual:
  68
  69       Introduction <Introduction.rst>
  70          Installing SimGrid <Installing_SimGrid.rst>
  71          Start your Own Project <Start_Your_Own_Project.rst>
  72       Describing your Application <application.rst>
  73          The S4U Interface <app_s4u.rst>
  74          The SMPI Interface <app_smpi.rst>
  75          The MSG Interface <app_msg.rst>
  76       Describing the Simulated Platform <platform.rst>
  77          Examples <Platform_Examples.rst>
  78          Modeling Hints <platform_howtos.rst>
  79          XML Reference <XML_Reference.rst>
  80       Describing the Experimental Scenario <Experimental_Setup.rst>
  81          Configuring SimGrid <Configuring_SimGrid.rst>
  82       The SimGrid Models <models.rst>
  83          ns-3 as a SimGrid model <ns3.rst>
  84       Simulation Outcomes <outcomes.rst>
  85       Use Cases and Howto <howto.rst>
  86       The SimGrid Community <community.rst>
  87       Frequently Asked Questions <faq.rst>
  88
  89
  90
  91 .. Cheat Sheet on the sublevels
  92 ..
  93 ..   # with overline, for parts
  94 ..   * with overline, for chapters
  95 ..   =, for sections
  96 ..   -, for subsections
  97 ..   ^, for subsubsections
  98 ..   ", for paragraphs