X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d2d4d192f42351fa0c53de8a3e268bb33c3bbe5c..98b64d0ca5df54ebf0dc3492a08fbab92b18416a:/docs/source/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 0b27fb8d66..9c41acb382 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,11 +1,13 @@ .. SimGrid documentation master file +.. _index: + The Modern Age of Computer Systems Simulation ============================================= -SimGrid is a framework to simulate distributed computer systems. It can be used -to either :ref:`assess abstract algorithms ` or to -:ref:`debug and profile real MPI applications `. +SimGrid is a framework to simulate distributed computer systems. It can be used to either :ref:`assess the performance of +abstract algorithms `, to :ref:`debug and profile real MPI applications `. To some extend, it can +also be used to :ref:`formally assess the correctness of simple algorithms and applications `. SimGrid is routinely used in studies on (data-)Grids, IaaS Clouds (:ref:`API `, :ref:`examples `), @@ -14,22 +16,22 @@ Peer-to-Peer systems, Volunteer Computing (`🖹 `__) Fog Computing (`🖹 `__), MapReduce (`🖹 `__) and -`much more `_. +`much more `_. The simulation models are **fast** (`🖹 `__) and **highly scalable** (`🖹 `__) while **theoretically sound and experimentally assessed** (`🖹 `__). Most of the time, SimGrid is used to predict the performance (time and energy) of a -given IT infrastructure, and it includes a prototype model checker to formally +given IT infrastructure, and it includes a prototypical model checker to formally assess these systems. Technically speaking, SimGrid is a library. It is neither a graphical interface nor a command-line simulator running user scripts. The interaction with SimGrid is done by writing programs with the exposed -functions to build your own simulator. This can be done in C/C++, Python or Java, +functions to build your own simulator. This can be done in C/C++ or Python, on Linux, Mac OSX or Windows (using the WSL). -SimGrid is a Free Software distributed under the LGPL-2.1 license. You are +SimGrid is a Free Software distributed under the LGPL-2.1-only license. You are welcome to use, study, share and improve it, provided that your version is as free as ours. SimGrid is developed for 20 years by a lively community of users and researchers from several groups, initially in France and the U.S.A. It @@ -54,8 +56,9 @@ of every page. Bugs in the code should be reported :maxdepth: 1 :caption: Tutorials: - Simulating Algorithms - Simulating MPI Applications + Simulating distributed algorithms + Simulating MPI applications + Model-checking algorithms .. toctree:: :hidden: @@ -64,25 +67,27 @@ of every page. Bugs in the code should be reported Introduction    Installing SimGrid -    Start your own project +    Start your own project +    The SimGrid community +    Release Notes Describing your application    The S4U interface +    S4U examples    The SMPI interface -    The MSG interface    The XBT toolbox - Describing the simulated platform -    Examples -    Modeling hints -    Defining a routing -    XML reference - Describing the experimental setup + Describing the simulated platform +    Network topology examples +    Advanced routing +    XML reference +    C++ platforms + The SimGrid models +    Modeling hints +    Calibrating the models +    SimGrid plugins + Running an experiment    Configuring SimGrid -    Deploying your application -    The SimGrid models - SimGrid plugins - Simulation outcomes - The SimGrid Community - Frequently asked questions +    Deploying your application +    Simulation outcomes .. toctree:: :hidden: @@ -90,6 +95,7 @@ of every page. Bugs in the code should be reported :caption: SimGrid's Internals: Design goals + Contributor's documentation .. Cheat Sheet on the sublevels ..