Merge branch 'master' of framagit.org:simgrid/simgrid

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

diff --git a/docs/source/index.rst b/docs/source/index.rst
index dc00ace130d78db82ed415156c0d6087e1b5b1aa..237cc89c09b308509a63ba3ab8bc215523ece4fc 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -4,8 +4,8 @@ The Modern Age of Computer Systems Simulation
 =============================================
 
 SimGrid is a framework to simulate distributed computer systems. It can be used
 =============================================
 
 SimGrid is a framework to simulate distributed computer systems. It can be used

-to either `assess abstract algorithms <usecase_simalgo>`_, or to `debug and
-profile real MPI applications <usecase_smpi>`_.
+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>`),
 
 SimGrid is routinely used in studies on (data-)Grids,
 IaaS Clouds (:ref:`API <API_s4u_VirtualMachine>`, :ref:`examples <s4u_ex_clouds>`),


@@ -20,7 +20,7 @@ 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 prototypal model-checker to formally
+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
 assess these systems.
 
 Technically speaking, SimGrid is a library. It is neither a graphical


@@ -31,17 +31,17 @@ on Linux, Mac OSX or Windows (using the WSL).
 
 SimGrid is a Free Software distributed under the LGPL-2.1 license. You are
 welcome to use, study, share and improve it, provided that your version are as
 
 SimGrid is a Free Software distributed under the LGPL-2.1 license. You are
 welcome to use, study, share and improve it, provided that your version are as

-free as ours. SimGrid is developed by a vivid community of users and developers.
-We hope that you will come and join us! SimGrid is the result of almost 20 years
-of research from several groups, both in France and in the U.S.A. It benefited
-of many funding from various research bodies.
+free as ours. SimGrid is developed since 20 years by a lively community of users
+and researchers from several groups, initially in France and in 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 taking the best
 of it. Check its contents on the left. Each tutorial presents a classical use
 
 SimGrid is a powerful tool, and this documentation will help you taking the best
 of it. Check its contents on the left. Each tutorial presents a classical use

-case, in a fast and practical manner. The user manual containts more
-throughfully information. In each part, the important concepts are concisely
+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
 introduced, before the reference manual. SimGrid is also described in several

-`scientific papers <https://simgrid.org/Publications.html>`_.
+`scientific papers <https://simgrid.org/usages.html>`_.

 
 Please report any documentation issue, including typos or unclear elements. You
 can even propose changes by clicking on the "Edit on FramaGit" button at the top
 
 Please report any documentation issue, including typos or unclear elements. You
 can even propose changes by clicking on the "Edit on FramaGit" button at the top


@@ -49,10 +49,6 @@ of every page. Bugs in the code should be reported
 `on FramaGit <https://framagit.org/simgrid/simgrid/issues>`_
 
 
 `on FramaGit <https://framagit.org/simgrid/simgrid/issues>`_
 
 

-.. TODO
-..
-.. The webpage should be made light, graphical and nice looking.
-

 .. toctree::
    :hidden:
    :maxdepth: 1
 .. toctree::
    :hidden:
    :maxdepth: 1


@@ -68,23 +64,26 @@ of every page. Bugs in the code should be reported
 
       Introduction <Introduction.rst>
          Installing SimGrid <Installing_SimGrid.rst>
 
       Introduction <Introduction.rst>
          Installing SimGrid <Installing_SimGrid.rst>

-         Start your Own Project <Start_Your_Own_Project.rst>
-      Describing your Application <application.rst>
-         The S4U Interface <app_s4u.rst>
-         The SMPI Interface <app_smpi.rst>
-         The MSG Interface <app_msg.rst>
-      Describing the Simulated Platform <platform.rst>
+         Start your own project <Start_Your_Own_Project.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>

          Examples <Platform_Examples.rst>
          Examples <Platform_Examples.rst>

-         Modeling Hints <platform_howtos.rst>
-         XML Reference <XML_Reference.rst>
-      Describing the Experimental Scenario <Experimental_Setup.rst>
+         Modeling hints <platform_howtos.rst>
+         Defining a routing <Platform_Routing.rst>
+         XML reference <XML_Reference.rst>
+      Describing the experimental setup <Experimental_Setup.rst>

          Configuring SimGrid <Configuring_SimGrid.rst>
          Configuring SimGrid <Configuring_SimGrid.rst>

-      The SimGrid Models <models.rst>
+         Deploying your application <Deploying_your_Application.rst>
+      The SimGrid models <models.rst>

          ns-3 as a SimGrid model <ns3.rst>
          ns-3 as a SimGrid model <ns3.rst>

-      Simulation Outcomes <outcomes.rst>
-      Use Cases and Howto <howto.rst>
-      The SimGrid Community <community.rst>
-      Frequently Asked Questions <faq.rst>
+      SimGrid plugins <Plugins.rst>
+      Simulation outcomes <outcomes.rst>
+      The SimGrid Ccmmunity <community.rst>
+      Frequently asked questions <faq.rst>