python3-dev is another dependency of the Python bindings

[simgrid.git] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index b171262..9c41acb 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,11 +1,13 @@
 .. SimGrid documentation master file
 
 .. SimGrid documentation master file
 

+.. _index:
+

 The Modern Age of Computer Systems Simulation
 =============================================
 
 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 <usecase_simalgo>` or to
-:ref:`debug and profile real MPI applications <usecase_smpi>`.
+SimGrid is a framework to simulate distributed computer systems. It can be used to either :ref:`assess the performance of
+abstract algorithms <usecase_simalgo>`, to :ref:`debug and profile real MPI applications <usecase_smpi>`. To some extend, it can
+also be used to :ref:`formally assess the correctness of simple algorithms and applications <usecase_modelchecking>`.

 
 SimGrid is routinely used in studies on (data-)Grids,
 IaaS Clouds (:ref:`API <API_s4u_VirtualMachine>`, :ref:`examples <s4u_ex_clouds>`),
 
 SimGrid is routinely used in studies on (data-)Grids,
 IaaS Clouds (:ref:`API <API_s4u_VirtualMachine>`, :ref:`examples <s4u_ex_clouds>`),


@@ -20,16 +22,16 @@ The simulation models are **fast** (`🖹 <http://hal.inria.fr/hal-00650233>`__)
 **highly scalable** (`🖹 <http://hal.inria.fr/inria-00602216/>`__) while
 **theoretically sound and experimentally assessed** (`🖹 <http://doi.acm.org/10.1145/2517448>`__).
 Most of the time, SimGrid is used to predict the performance (time and energy) of a
 **highly scalable** (`🖹 <http://hal.inria.fr/inria-00602216/>`__) while
 **theoretically sound and experimentally assessed** (`🖹 <http://doi.acm.org/10.1145/2517448>`__).
 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
 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).
 
 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
 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


@@ -70,22 +72,22 @@ of every page. Bugs in the code should be reported
          Release Notes <Release_Notes.rst>
       Describing your application <application.rst>
          The S4U interface <app_s4u.rst>
          Release Notes <Release_Notes.rst>
       Describing your application <application.rst>
          The S4U interface <app_s4u.rst>

+         S4U examples <Examples.rst>

          The SMPI interface <app_smpi.rst>
          The SMPI interface <app_smpi.rst>

-         The MSG interface <app_msg.rst>

          The XBT toolbox <The_XBT_toolbox.rst>
       Describing the simulated platform <Platform.rst>
          Network topology examples <Platform_examples.rst>
          Advanced routing <Platform_routing.rst>
          XML reference <XML_reference.rst>
          C++ platforms <Platform_cpp.rst>
          The XBT toolbox <The_XBT_toolbox.rst>
       Describing the simulated platform <Platform.rst>
          Network topology examples <Platform_examples.rst>
          Advanced routing <Platform_routing.rst>
          XML reference <XML_reference.rst>
          C++ platforms <Platform_cpp.rst>

-      The SimGrid models <Models.rst>      
-         SimGrid plugins <Plugins.rst>
+      The SimGrid models <Models.rst>

          Modeling hints <Modeling_howtos.rst>
          Modeling hints <Modeling_howtos.rst>

+         Calibrating the models <Calibrating_the_models.rst>
+         SimGrid plugins <Plugins.rst>

       Running an experiment <Experimental_setup.rst>
          Configuring SimGrid <Configuring_SimGrid.rst>
          Deploying your application <Deploying_your_application.rst>
          Simulation outcomes <Outcomes.rst>
       Running an experiment <Experimental_setup.rst>
          Configuring SimGrid <Configuring_SimGrid.rst>
          Deploying your application <Deploying_your_application.rst>
          Simulation outcomes <Outcomes.rst>

-      Frequently asked questions <faq.rst>

 
 .. toctree::
    :hidden:
 
 .. toctree::
    :hidden:


@@ -93,6 +95,7 @@ of every page. Bugs in the code should be reported
    :caption: SimGrid's Internals:
 
       Design goals <Design_goals.rst>
    :caption: SimGrid's Internals:
 
       Design goals <Design_goals.rst>

+      Contributor's documentation <Contributors_Documentation.rst>

 
 .. Cheat Sheet on the sublevels
 ..
 
 .. Cheat Sheet on the sublevels
 ..