X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/501196fba8269024636b011851ce7ea63d7696c9..b4231b0645214b4b40d6600de12a172f98ad45b2:/docs/source/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 91fd582cd3..91da4d3c0f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,15 +1,60 @@ .. SimGrid documentation master file -Welcome to SimGrid's documentation! -=================================== +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 routinely used in studies on (data-)Grids, +IaaS Clouds (:ref:`API `, :ref:`examples `), +Clusters, High Performance Computing (`🖹 `_), +Peer-to-Peer systems, +Volunteer Computing (`🖹 `__) +Fog Computing (`🖹 `__), +MapReduce (`🖹 `__) and +`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 prototypal 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 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 vivid community of users +and researchers from several groups, initially in France and in the U.S.A. It +benefited of many funding from various 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 +case, in a fast and practical manner. The user manual containts more +throughfully 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 +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 `_ + .. TODO .. -.. Change the content of this page to integrate the verbose content of the webpage. -.. The toctrees should be made hidden to only live as a sidebar. .. The webpage should be made light, graphical and nice looking. .. toctree:: + :hidden: :maxdepth: 1 :caption: Tutorials: @@ -17,24 +62,25 @@ Welcome to SimGrid's documentation! Simulating MPI Applications .. toctree:: + :hidden: :maxdepth: 2 :caption: User Manual: - Introduction -    Main Concepts + Introduction    Installing SimGrid    Start your Own Project Describing your Application    The S4U Interface    The SMPI Interface    The MSG Interface -    The Java Bindings Describing the Simulated Platform +    Examples    Modeling Hints -    DTD Reference - Describing the Experimental Scenario +    XML Reference + Describing the Experimental Setup    Configuring SimGrid The SimGrid Models +    ns-3 as a SimGrid model Simulation Outcomes Use Cases and Howto The SimGrid Community