X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/08e7455d67920bbd7a87f440d00f2c1e071314a0..ea74f5d95928a521a588737e81f1de94eef25d19:/docs/source/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 4eeab334e8..79d021492a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,17 +4,17 @@ 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 +to either :ref:`assess abstract algorithms ` or to :ref:`debug and profile real MPI applications `. SimGrid is routinely used in studies on (data-)Grids, IaaS Clouds (:ref:`API `, :ref:`examples `), -Clusters, High Performance Computing (`🖹 `_), +Clusters, High-Performance Computing (`🖹 `_), Peer-to-Peer systems, Volunteer Computing (`🖹 `__) Fog Computing (`🖹 `__), MapReduce (`🖹 `__) and -`much more `_. +`much more `_. The simulation models are **fast** (`🖹 `__) and **highly scalable** (`🖹 `__) while @@ -30,20 +30,20 @@ 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 license. You are -welcome to use, study, share and improve it, provided that your version are as -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 +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 taking the best +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 `_. -Please report any documentation issue, including typos or unclear elements. You +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 `_ @@ -54,8 +54,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,27 +65,34 @@ of every page. Bugs in the code should be reported Introduction    Installing SimGrid -    Start your Own Project - Describing your Application -    The S4U Interface -    The SMPI Interface -    The MSG Interface - Describing the Simulated Platform -    Examples -    Modeling Hints -    Defining a Routing -    XML Reference - Describing the Experimental Setup +    Start your own project +    The SimGrid community +    Release Notes + Describing your application +    The S4U interface +    The SMPI interface +    The MSG interface +    The XBT toolbox + Describing the simulated platform +    Network topology examples +    Advanced routing +    XML reference +    C++ platforms + The SimGrid models +    SimGrid plugins +    Modeling hints +    Calibrating the models + Running an experiment    Configuring SimGrid -    Deploying your Application - The SimGrid Models -    ns-3 as a SimGrid model - SimGrid Plugins - Simulation Outcomes - The SimGrid Community - Frequently Asked Questions +    Deploying your application +    Simulation outcomes +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: SimGrid's Internals: + Design goals .. Cheat Sheet on the sublevels ..