From 00533592f78241ecab7ad63cf711457ea7ad9504 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sun, 16 Jun 2019 13:53:41 +0200 Subject: [PATCH] [doc] various doc small improvements --- docs/source/Tutorial_MPI_Applications.rst | 20 ++++++++++++-------- docs/source/platform.rst | 2 +- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/source/Tutorial_MPI_Applications.rst b/docs/source/Tutorial_MPI_Applications.rst index 87e9134a8f..eae9d38532 100644 --- a/docs/source/Tutorial_MPI_Applications.rst +++ b/docs/source/Tutorial_MPI_Applications.rst @@ -6,7 +6,7 @@ Simulating MPI Applications Discover SMPI ------------- -SimGrid can not only :ref:`simulate algorithms `, but +SimGrid can not only :ref:`simulate algorithms `, but it can also be used to execute real MPI applications on top of virtual, simulated platforms with the SMPI module. Even complex C/C++/F77/F90 applications should run out of the box in this @@ -95,12 +95,16 @@ simulated platform as a graph of hosts and network links. The elements basic elements (with :ref:`pf_tag_host` and :ref:`pf_tag_link`) are described first, and then the routes between -any pair of hosts are explicitely given with :ref:`pf_tag_route`. Any -host must be given a computational speed (in flops) while links must -be given a latency (in seconds) and a bandwidth (in bytes per -second). Note that you can write 1Gflops instead of 1000000000flops, -and similar. Last point: :ref:`pf_tag_route`s are symmetrical by -default (but this can be changed). +any pair of hosts are explicitely given with :ref:`pf_tag_route`. + +Any host must be given a computational speed in flops while links must +be given a latency and a bandwidth. You can write 1Gf for +1,000,000,000 flops (full list of units in the reference guide of +:ref:`pf_tag_host` and :ref:`pf_tag_link`). + +Routes defined with :ref:`pf_tag_route` are symmetrical by default, +meaning that the list of traversed links from A to B is the same as +from B to A. Explicitely define non-symmetrical routes if you prefer. Cluster with a Crossbar ....................... @@ -623,7 +627,7 @@ Further Readings You may also be interested in the `SMPI reference article `_ or these `introductory slides `_. The :ref:`SMPI -reference documentation ` covers much more content than +reference documentation ` covers much more content than this short tutorial. Finally, we regularly use SimGrid in our teachings on MPI. This way, diff --git a/docs/source/platform.rst b/docs/source/platform.rst index 1909927daf..aa2574749c 100644 --- a/docs/source/platform.rst +++ b/docs/source/platform.rst @@ -75,7 +75,7 @@ Networking zones (:ref:`pf_tag_zone`) are used to factorize the description to reduce the size of your platform on disk and in memory. Then, when a host wants to communicate with another host belonging to the same zone, it is the zone's duty to find the list of links that are -involved in the communication. In the above example, since we use +involved in the communication. In the above examples, since we use ``routing="Full"``, all routes must be explicitly given using the :ref:`pf_tag_route` and :ref:`pf_tag_link_ctn` tags (this :ref:`routing model ` is both simple and inefficient :) It is OK to not -- 2.20.1