From 5e6fc8225c34cb367d726ece86b7253331b78929 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sun, 30 Jun 2019 13:30:58 +0200 Subject: [PATCH] last cleanups to the doc. I stop now for today. --- docs/source/Platform_Examples.rst | 47 ++++--------------------------- docs/source/index.rst | 10 +++---- 2 files changed, 10 insertions(+), 47 deletions(-) diff --git a/docs/source/Platform_Examples.rst b/docs/source/Platform_Examples.rst index 37cff2471d..fcfb76fdd2 100644 --- a/docs/source/Platform_Examples.rst +++ b/docs/source/Platform_Examples.rst @@ -15,48 +15,11 @@ Platform Examples ================= -Here is a very simple platform file, containing 3 resources (two hosts -and one link), and explicitly giving the route between the hosts. +SimGrid comes with an extensive set of platforms in the +`examples/platforms `_ +directory. -.. literalinclude:: ../../examples/platforms/two_hosts.xml - :language: xml +.. todo:: Write this page of the manual. -The root tag must be ````, and its ``version`` attribute -specifies the used DTD version. When the DTD evolutions introduce -backward-incompatible changes, this number gets updated. Use the -``simgrid_update_xml`` utility to upgrade your platform files on need. - - -Then, every platform element must be located within a given -**networking zone** introduced with the :ref:`pf_tag_zone` tag. Zones -are in charge of the routing: an host wants to communicate with -another host of the same zone, it is the zone's duty to find the list -of links that are involved in the communication. Here, since we use -``routing="Full"``, all routes must be explicitly given using the -:ref:`pf_tag_route` and :ref:`pf_tag_linkctn` tags (this :ref:`routing -model ` is both simple and inefficient :) It is OK to not -specify each and every route between hosts, as long as you don't start -at runtime any communications on the missing routes. - -Any zone may contain sub-zones itself, leading to a hierarchical -decomposition of the platform. This can be more efficient (as the -inter-zone routing gets factorized with :ref:`pf_tag_zoneroute`), and -allows to have more than one routing model in your platform. For -example, you could have a coordinate-based routing for the WAN parts -of your platforms, a full routing within each datacenter, and a highly -optimized routing within each cluster of the datacenter. In this -case, determining the route between two given hosts gets @ref -routing_basics "somewhat more complex" but SimGrid still computes -these routes for you in a time- and space-efficient manner. -Here is an illustration of these concepts: - -.. image:: img/zone_hierarchy.png - -The zone "AS2" models the core of a national network interconnecting a -small flat cluster (AS4) and a larger hierarchical cluster (AS5), a -subset of a LAN (AS6), and a set of peers scattered around the world -(AS7). - -.. todo:: Add more examples, such as the cloud example descibed in - previous paragraph + Gather here the examples described elsewhere in the doc (SMPI tutorial, Platform intro), and describe the other ones. diff --git a/docs/source/index.rst b/docs/source/index.rst index dc00ace130..d29d04ed98 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -31,10 +31,10 @@ 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. +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 @@ -77,7 +77,7 @@ of every page. Bugs in the code should be reported    Examples    Modeling Hints    XML Reference - Describing the Experimental Scenario + Describing the Experimental Setup    Configuring SimGrid The SimGrid Models    ns-3 as a SimGrid model -- 2.20.1