docs/source/platform.rst

   1 .. _platform:
   2
   3 .. raw:: html
   4
   5    <object id="TOC" data="graphical-toc.svg" width="100%" type="image/svg+xml"></object>
   6    <script>
   7    window.onload=function() { // Wait for the SVG to be loaded before changing it
   8      var elem=document.querySelector("#TOC").contentDocument.getElementById("PlatformBox")
   9      elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1";
  10    }
  11    </script>
  12    <br/>
  13    <br/>
  14
  15 Describing your Simulated Platform
  16 ##################################
  17
  18 The goal of SimGrid is to run an application on a simulated platform.
  19 For that, you have to describe **each element of your platform**, such
  20 as computing hosts, clusters, each disks, links, etc. You must also
  21 define the **routing on your platform**, ie which path is taken
  22 between two hosts. Finally, you may also describe an **experimental
  23 scenario**, with qualitative changes (e.g., bandwidth changes
  24 representing an external load) and qualitative changes (representing
  25 how some elements fail and restart over time).
  26
  27 You should really separate your application from the platform
  28 description, as it will ease your experimental campain afterward.
  29 Mixing them is seen as a really bad experimental practice. The easiest
  30 to enforce this split is to put the platform description in a XML
  31 file. Many example platforms are provided in the archive, and this
  32 page gives all needed details to write such files, as well as some
  33 hints and tricks about describing your platform.
  34
  35 On the other side, XML is sometimes not expressive enough, in
  36 particular for large platforms exhibiting repetitive patterns that are
  37 not simply expressed in XML.  In practice, many users end up
  38 generating their XML platform files from some sort of scripts. It is
  39 probably preferable to rewrite your XML :ref:`platform using the lua
  40 scripting language <platform_lua>` instead.  In the future, it should
  41 be possible to describe the platform in python or directly in C++, but
  42 this is not possible yet.
  43
  44
  45 ..  LocalWords:  SimGrid