From: Martin Quinson Date: Fri, 28 Jun 2019 21:54:25 +0000 (+0200) Subject: Put the documentation intro on the first page X-Git-Tag: v3.23.2~65 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/808e3788e31d306aa2d3f8c96122aa82346fbe0b Put the documentation intro on the first page That's a bit stupid to hide the introduction deep below. --- diff --git a/docs/Build.sh b/docs/Build.sh index 4096cfdaad..12fa8ceed2 100755 --- a/docs/Build.sh +++ b/docs/Build.sh @@ -2,6 +2,9 @@ # # Simplistic script to rebuild our documentation with sphinx-build +# Python needs to find simgrid on my machine, but not ctest -- sorry for the hack +if [ -e /opt/simgrid ] ; then chmod +x /opt/simgrid; fi + set -e if [ "x$1" != 'xdoxy' -a -e build/xml ] ; then @@ -53,3 +56,6 @@ do fi fi done + +set +e +if [ -e /opt/simgrid ] ; then chmod +x /opt/simgrid; fi diff --git a/docs/source/intro_concepts.rst b/docs/source/Introduction.rst similarity index 100% rename from docs/source/intro_concepts.rst rename to docs/source/Introduction.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 37a0dfecb3..79e46c8b32 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 `assess abstract algorithms `_, or to `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 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. + +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,11 +62,11 @@ 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 diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst deleted file mode 100644 index b0b2134f45..0000000000 --- a/docs/source/introduction.rst +++ /dev/null @@ -1,33 +0,0 @@ -What is SimGrid -*************** - -SimGrid is a framework to simulate distributed computer systems. - -It can be used to either assess abstract algorithms or to profile and -debug real distributed applications. SimGrid enables studies in the -domains of (data-)Grids, IaaS Clouds, Clusters, High Performance -Computing, Volunteer Computing, and Peer-to-Peer 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. - -SimGrid is a Free Software distributed under the LGPL-2.1 license. You are -thus welcome to use it as you wish or even to modify and distribute -your version (provided that your version is as free as ours). It also -means that 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, including the ANR, Inria, CNRS, -University of Lorraine, University of Hawai'i at Manoa, ENS Rennes, and -many others. Many thanks to our generous sponsors! - -SimGrid is a powerful tool, but its learning curve can be rather -steep. This manual will hopefully help and guide you to the features -you want to use. Please report any issue that you see in this manual, -including typos or unclear elements. You can even propose changes by -clicking on the "Edit on GitLab" button at the top of every page. - diff --git a/examples/s4u/README.rst b/examples/s4u/README.rst index 0c07fa8463..f11fc88fc1 100644 --- a/examples/s4u/README.rst +++ b/examples/s4u/README.rst @@ -406,6 +406,8 @@ Distributed Hash Tables (DHT) One of the most famous DHT protocol. |br| `examples/s4u/dht-chord/s4u-dht-chord.cpp `_ +.. _s4u_ex_clouds: + Simulating Clouds ----------------- diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake index a2b3c1c127..81dd93e68a 100644 --- a/tools/cmake/DefinePackages.cmake +++ b/tools/cmake/DefinePackages.cmake @@ -887,8 +887,7 @@ set(DOC_SOURCES docs/source/app_smpi.rst docs/source/community.rst docs/source/index.rst - docs/source/intro_concepts.rst - docs/source/introduction.rst + docs/source/Introduction.rst docs/source/Installing_SimGrid.rst docs/source/Start_Your_Own_Project.rst docs/source/models.rst