@subsection pf_res_computing Computing Resources
-@subsubsection pf_tag_host <host>
-
-An host is the computing resource on which an actor can execute.
-
-Attribute | Values | Description
------------------ | -------------------------------------- | -----------
-id | String (mandatory) | The identifier of the host. facilitates referring to this AS.
-speed | double (mandatory) | Computational power of every core of this host in FLOPS (must be positive)
-core | int (defaults to 1) | Number of cores (see @ref howto_multicore)
-availability_file | File name (optional) | (Relative or absolute) filename to use as input; must contain availability traces for this host. The syntax of this file is defined below.
-state_file | File name (optional) | File to use as a state profile (see @ref howto_churn)
-coordinates | String (mandatory when using Vivaldi routing) | The coordinates of this host (see @ref pf_P2P_tags).
-pstate | Double (Defaults to 0) | FIXME: Not yet documented.
-
-#### Included tags ####
-
- - @ref pf_tag_mount Specifies the storages mounted on that host
- - @ref pf_tag_prop Specifies a user-defined property of that host, that you can retrieve with MSG_host_get_property_value() or simgrid::s4u::Host::property().
-
-#### Examples ####
-
-@code{.xml}
-<host id="host1" speed="1000000000"/>
-<host id="host2" speed="1000000000">
- <prop id="color" value="blue"/>
- <prop id="rendershape" value="square"/>
-</host>
-@endcode
-
-@anchor pf_host_dynamism
-### Expressing dynamism ###
-
-SimGrid provides mechanisms to change a hosts' availability over
-time, using the ``availability_file`` attribute to the ``@<host@>`` tag
-and a separate text file whose syntax is exemplified below.
-
-#### Adding a trace file ####
-
-@verbatim
-<platform version="4">
- <host id="bob" speed="500Gf" availability_file="bob.trace" />
-</platform>
-@endverbatim
-
-#### Example of "bob.trace" file ####
-
-~~~~~~~~~~~~~~{.py}
-PERIODICITY 1.0
- 0.0 1.0
- 11.0 0.5
- 20.0 0.8
-~~~~~~~~~~~~~~
-
-Let us begin to explain this example by looking at line 2. (Line 1 will become clear soon).
-The first column describes points in time, in this case, time 0. The second column
-describes the relative amount of power this host is able to deliver (relative
-to the maximum performance specified in the ``@<host@>`` tag). (Clearly, the
-second column needs to contain values that are not smaller than 0 and not larger than 1).
-In this example, our host will deliver 500 Mflop/s at time 0, as 500 Mflop/s is the
-maximum performance of this host. At time 11.0, it will
-deliver half of its maximum performance, i.e., 250 Mflop/s until time 20.0 when it will
-will start delivering 80@% of its power. In this example, this amounts to 400 Mflop/s.
-
-Since the periodicity in line 1 was set to be 1.0, i.e., 1 timestep, this host will
-continue to provide 500 Mflop/s from time 21. From time 32 it will provide 250 MFlop/s and so on.
@subsubsection pf_tag_cluster <cluster>
etc.
-@subsubsection pf_peer <peer> (Vivaldi netzones only)
-
-This tag represents a peer, as in Peer-to-Peer (P2P) networks. This
-can only be used in Vivaldi NetZones. It creates the following
-resources to the NetZone:
-
-@li A host
-@li Two links: One for download and one for upload. This is
- convenient to use and simulate stuff under the last mile model (e.g., ADSL peers).
-@li It connects the two links to the host
-
-#### Attributes ####
-
-Attribute name | Mandatory | Values | Description
---------------- | --------- | ------ | -----------
-id | yes | string | The identifier of the peer. Facilitates referring to this peer.
-speed | yes | int | See the description of the ``host`` tag for this attribute
-bw_in | yes | int | Bandwidth of the private downstream link
-bw_out | yes | int | Bandwidth of the private upstream link
-coordinates | no | string | Coordinates of the gateway for this peer. Example value: 12.8 14.4 6.4
-sharing_policy | no | SHARED@|SPLITDUPLEX (default: SPLITDUPLEX) | Sharing policy for links. See <b>link</b> description for details.
-availability_file| no | string | Availability file for the peer. Same as host availability file. See <b>host</b> description for details.
-state_file | no | string | State file for the peer. Same as host state file. See <b>host</b> description for details.
-
-
-The communication latency between an host A=(xA,yA,zA) and an host
-B=(xB,yB,zB) is computed as follows:
-
- latency = sqrt( (xA-xB)² + (yA-yB)² ) + zA + zB
-
-See the documentation of simgrid::kernel::routing::VivaldiZone for
-details on how the latency is computed from the coordinate, and on the
-the up and down bandwidth are used.
-
@subsection pf_ne Network equipments
There are two tags at all times available to represent network entities and
If you want to represent an entity like a switch, you must use ``<link>`` (see section). Routers are used
to run some routing algorithm and determine routes (see Section @ref pf_routing for details).
-@subsubsection pf_router <router/>
-
-As said before, <b>router</b> is used only to give some information
-for routing algorithms. So, it does not have any attributes except:
-
-#### Attributes ####
-
-Attribute name | Mandatory | Values | Description
---------------- | --------- | ------ | -----------
-id | yes | string | The identifier of the router to be used when referring to it.
-coordinates | no | string | Must be provided when choosing the Vivaldi, coordinate-based routing model for the network zone the router belongs to. More details can be found in the Section @ref pf_P2P_tags.
-
-#### Example ####
-
-@verbatim
- <router id="gw_dc1_horizdist"/>
-@endverbatim
-
@subsubsection pf_tag_link <link>
Network links can represent one-hop network connections. They are
<!-- The rest of your platform -->
</platform>
-
+|hr|
+
.. _pf_tag_host:
------------------------------------------------------------------
An host is the computing resource on which an actor can execute. See :cpp:class:`simgrid::s4u::Host`.
**Parent tags:** :ref:`pf_tag_zone` (only leaf zones, i.e. zones containing no inner zones nor clusters) |br|
-**Children tags:** :ref:`pf_tag_prop`, :ref:`pf_tag_storage` |br|
+**Children tags:** :ref:`pf_tag_mount`, :ref:`pf_tag_prop`, :ref:`pf_tag_storage` |br|
**Attributes:**
:``id``: Host name.
:``pstate``: Initial pstate (default: 0, the first one).
See :ref:`howto_dvfs`.
+|hr|
+
.. _pf_tag_link:
------------------------------------------------------------------
<link>
------------------------------------------------------------------
-Network links can represent one-hop network connections. See :cpp:class:`simgrid::s4u::Link`.
+Network links can represent one-hop network connections (see
+:cpp:class:`simgrid::s4u::Link`). SimGrid links can be used to
+represent either a single wire, or to abstract a larger network
+interconnect in a single element. A single link can for example be
+used to model the transcontinental network.
**Parent tags:** :ref:`pf_tag_zone` (both leaf zones and inner zones) |br|
**Children tags:** :ref:`pf_tag_prop` |br|
:ref:`pf_tag_link` are absolute values, but Availability
profiles of :ref:`pf_tag_host` are ratio.
:``state_file``: File containing the state profile. See :ref:`pf_tag_host`.
-
+
+|hr|
+
.. _pf_tag_peer:
------------------------------------------------------------------
:``state_file``: File containing the state profile.
See the full description in :ref:`pf_tag_host`
+|hr|
+
.. _pf_tag_platform:
------------------------------------------------------------------
upgrade most of the past platform files to the recent
formalism.
+|hr|
.. _pf_tag_prop:
:``id``: Name of the defined property.
:``value``: Value of the defined property.
+|hr|
+
.. _pf_tag_router:
------------------------------------------------------------------
.. |br| raw:: html
<br />
+
+.. |hr| raw:: html
+
+ <hr />
