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 In SimGrid, platforms are usually described in XML. This formalism has
  19 some drawbacks, but using a specific format ensures that the platform
  20 is not mixed with the tested application. This separation of concern
  21 :ref:`is a must <howto_science>` for your Modeling and Simulation (M&S)
  22 work. When XML is too limiting, you may describe your platforms using
  23 the :ref:`lua bindings <platform_lua>` (it is not yet possible to do so in
  24 python or directly in C++).
  25
  26 Since we know that writing platform description files is not trivial,
  27 we included :ref:`many examples <platform_examples>` in the archive. This
  28 documentation also contains some :ref:`hints and howtos <howto>`, as well
  29 as the full :ref:`XML reference guide <platform_reference>`.
  30
  31
  32 Any simulated platform must contain **basic elements**, such as hosts,
  33 links, storages, etc.  SimGrid gives you a great liberty when defining
  34 **routing of your platform**, ie the path taken between each pair of
  35 hosts.  Finally, you may also describe an **experimental scenario**,
  36 with qualitative changes (e.g., bandwidth changes representing an
  37 external load) and qualitative changes (representing how some elements
  38 fail and restart over time).
  39
  40
  41
  42 Defining Basic Elements
  43 ***********************
  44
  45 These are the components of your platform.
  46
  47
  48 There is not much to say about the definition of basic elements. Just
  49 use the appropriate tags: :ref:`pf_tag_host`, :ref:`pf_tag_link` and
  50 :ref:`pf_tag_storage`.
  51
  52 Defining a Routing
  53 ******************
  54
  55 Performance Profiles and Churn
  56 ******************************
  57
  58 ..  LocalWords:  SimGrid