************************************
Fast Network Simulation Setup (FNSS)
************************************

This is the documentation of the FNSS core library.
It is a Python library providing a set of features allowing to simplify the setup of a network simulation.
These features include the ability to:

 * Parse a topology from a dataset, a topology generator or generate it according to a number of synthetic models
 * Apply link capacity, link weights, link delays and buffer sizes
 * Deploy application stacks
 * Generate traffic matrices
 * Generate event schedules

In addition to the core library, FNSS comprises APIs written in other languages (Java and C++) and adapters for third-party network simulators (`ns-2 <http://www.isi.edu/nsnam/ns/>`_ and `ns-3 <http://www.nsnam.org/>`_).
The only function of these APIs and adapters is to parse topologies, event schedules and traffic matrices generated by the core library and easily import them in the desired target simulator. 

The FNSS core library is released under the terms of the `BSD license <https://raw.github.com/fnss/fnss/master/core/LICENSE.txt>`_.

If you use FNSS for your paper, please cite the following publication:

.. highlights::

    Lorenzo Saino, Cosmin Cocora and George Pavlou, 
    `"A Toolchain for Symplifying Network Simulation Setup"
    <http://www.ee.ucl.ac.uk/~lsaino/papers/fnss.pdf>`_,
    in `Proceedings of the 6th International ICST Conference on Simulation Tools and Techniques
    <http://www.simutools.org/2013>`_, 
    (Cannes, France), Mar 2013

The BibTeX entry is::

    @inproceedings{fnss,
         author = {Saino, Lorenzo and Cocora, Cosmin and Pavlou, George},
         title = {A Toolchain for Simplifying Network Simulation Setup},
         booktitle = {Proceedings of the 6th International ICST Conference on Simulation Tools and Techniques},
         series = {SIMUTOOLS '13},
         year = {2013},
         location = {Cannes, France},
         numpages = {10},
         publisher = {ICST (Institute for Computer Sciences, Social-Informatics and Telecommunications Engineering)},
         address = {ICST, Brussels, Belgium, Belgium},
    } 


Contents
========

.. toctree::
   :maxdepth: 4

   architecture
   install
   apidoc/index
   examples/index

    
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`




