Descriptor
==========

This first repository is the basis for the analysis of a network. It enables the description of a network, and can be
used directly as is fo the analysis of a FIFO network or a network with blind multiplexing (no assumption about the
scheduling policy). The modules are:

- :mod:`curves`, the modules that describe token-bucket curves and rate-latency curves. They are use to respectively
  characterize the arrival and service curves.
- :mod:`flow`, the module to describe a flow. In the simplest model(here), it simply consists of  an arrival curve
  (list of token-buckets, interpreted as the minimum of these token-buckets, and a path (list of servers crossed by
  this flow)
- :mod:`server`, the module to describe a server. It consists of a minimal arrival curve (a list of rate-latency
  functions interpreted as the maximum of these functions, and a maximum service curve (more precisely, a shaper for
  the curve, that is a list of token-bucket functions interpreted as a minimum of token-bucket functions.
- :mod:`network`, the module to describe a network, as a list of servers and a list of flows. Many functions are
  associated to it, such as computing some topologic proprties (list of predecesors and successors...)


.. toctree::
   :maxdepth: 4

   curves
   flow
   network
   server