X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9bfc714f74d8044a224b5c94ad3f69e540361841..74c1ec0ea946c5cb680969bc982a53326a1c0a59:/docs/source/index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 1cd37b77f2..050033fd45 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,38 +1,106 @@
 .. SimGrid documentation master file
 
-Welcome to SimGrid's documentation!
-===================================
+.. _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 <usecase_simalgo>` or to
+:ref:`debug and profile real MPI applications <usecase_smpi>`.
+
+SimGrid is routinely used in studies on (data-)Grids,
+IaaS Clouds (:ref:`API <API_s4u_VirtualMachine>`, :ref:`examples <s4u_ex_clouds>`),
+Clusters, High-Performance Computing (`🖹 <http://hal.inria.fr/hal-01415484>`_),
+Peer-to-Peer systems,
+Volunteer Computing (`🖹 <http://www.sciencedirect.com/science/article/pii/S1569190X17301028>`__)
+Fog Computing (`🖹 <http://ieeexplore.ieee.org/document/7946412/>`__),
+MapReduce (`🖹 <http://www.sciencedirect.com/science/article/pii/S0167819113000215>`__) and
+`much more <https://simgrid.org/usages.html>`_.
+
+The simulation models are **fast** (`🖹 <http://hal.inria.fr/hal-00650233>`__) and
+**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
+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,
+on Linux, Mac OSX or Windows (using the WSL).
+
+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
+is steadily funded by several research bodies. We hope that you will
+come and join us!
+
+SimGrid is a powerful tool, and this documentation will help you to make good use
+of it. Check its contents on the left. Each tutorial presents a classical use
+case, in a fast and practical manner. The user manual contains more
+thorough information. In each part, the important concepts are concisely
+introduced, before the reference manual. SimGrid is also described in several
+`scientific papers <https://simgrid.org/usages.html>`_.
+
+Please report any documentation issues, including typos or unclear elements. You
+can even propose changes by clicking on the "Edit on FramaGit" button at the top
+of every page. Bugs in the code should be reported
+`on FramaGit <https://framagit.org/simgrid/simgrid/issues>`_
+
 
 .. toctree::
+   :hidden:
    :maxdepth: 1
    :caption: Tutorials:
 
-	Simulating Algorithms <tuto_s4u.rst>
-	Simulating MPI Applications <tuto_smpi.rst>
+	Simulating distributed algorithms <Tutorial_Algorithms.rst>
+	Simulating MPI applications <Tutorial_MPI_Applications.rst>
+	Model-checking algorithms <Tutorial_Model-checking.rst>
 
 .. toctree::
+   :hidden:
    :maxdepth: 2
    :caption: User Manual:
 
-      Introduction <introduction.rst>
-      Describing your Application <application.rst>
-      Describing the Virtual Platform <platform.rst>
-      Describing the Experimental Scenario <scenario.rst>
-      The SimGrid Models <models.rst>
-      Simulation Outcomes <outcomes.rst>
-      Use Cases and Howto <howto.rst>
-      The SimGrid Community <community.rst>
-      Frequently Asked Questions <faq.rst>
+      Introduction <Introduction.rst>
+         Installing SimGrid <Installing_SimGrid.rst>
+         Start your own project <Start_your_own_project.rst>
+         The SimGrid community <community.rst>
+         Release Notes <Release_Notes.rst>
+      Describing your application <application.rst>
+         The S4U interface <app_s4u.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 SimGrid models <Models.rst>      
+         SimGrid plugins <Plugins.rst>
+         Modeling hints <Modeling_howtos.rst>
+         Calibrating the models <Calibrating_the_models.rst>   
+      Running an experiment <Experimental_setup.rst>
+         Configuring SimGrid <Configuring_SimGrid.rst>
+         Deploying your application <Deploying_your_application.rst>
+         Simulation outcomes <Outcomes.rst>
 
 .. toctree::
-   :maxdepth: 2
    :hidden:
-   :caption: API Reference:
-
-	     API <api/library_root.rst>
+   :maxdepth: 2
+   :caption: SimGrid's Internals:
 
-Indices and tables
-==================
+      Design goals <Design_goals.rst>
 
-* :ref:`genindex`
-* :ref:`search`
+.. Cheat Sheet on the sublevels
+..
+..   # with overline, for parts
+..   * with overline, for chapters
+..   =, for sections
+..   -, for subsections
+..   ^, for subsubsections
+..   ", for paragraphs