README.md

   1 [![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu)
   2
   3 # son-emu
   4 This is the repository of [SONATA's](http://sonata-nfv.eu) emulation platform.
   5
   6 This emulation platform was created to support network  service developers to locally prototype and test complete network service chains in realistic end-to-end multi-PoP scenarios. It allows the direct execution of real network functions, packaged as Docker containers, in emulated network topologies running locally on the network service developer's machine.
   7
   8 More details about the the emulator's architecture and concepts can be found in the following publication:
   9
  10 * Peuster, Manuel, Holger Karl, and Steven van Rossem. ["MeDICINE: Rapid Prototyping of Production-Ready Network Services in Multi-PoP Environments."](http://arxiv.org/abs/1606.05995) pre-print arXiv:1606.05995 (2016).
  11
  12 ## Development
  13 (if applicable)
  14
  15 ### Building
  16 Describe briefly how to build the software.
  17
  18 ### Dependencies
  19
  20 * [argparse](https://pypi.python.org/pypi/argparse) >= 1.4.0 (Python software foundation License)
  21 * [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(Apache 2.0)
  22 * [Flask](https://pypi.python.org/pypi/Flask) >= 0.11 (BSD)
  23 * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD)
  24 * [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11  (BSD)
  25 * [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0  (Apache 2.0)
  26 * [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL)
  27 * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0)
  28 * [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL)
  29 * [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT)
  30 * [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT)
  31 * [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0)
  32 * [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0)
  33 * [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT)
  34 * [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain)
  35 * [urllib3](https://pypi.python.org/pypi/urllib3) >= 1.15 (MIT)
  36 * [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT)
  37
  38 ### Contributing
  39 (if applicable) Description (encouraging) how to contribute to this project/repository.
  40
  41 ## Installation
  42 (if applicable) Describe briefly how to install the software. You may want to put a link to son-install instead:
  43
  44 The installation of this component can be done using the [son-install](https://github.com/sonata-nfv/son-install) script.
  45
  46 ## Usage
  47 (if applicable) Describe briefly how to use the software.
  48
  49 ## License
  50
  51 This [SOFTWARE] is published under Apache 2.0 license. Please see the LICENSE file for more details.
  52
  53 ## Useful Links
  54
  55 * Any useful link and brief description. For example:
  56 * http://www.google/ Don't be evil.
  57
  58 ---
  59 #### Lead Developers
  60
  61 The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.
  62
  63 * Manuel Peuster (mpeuster)
  64 * Steven Van Rossem (stevenvanrossem)
  65
  66 #### Feedback-Chanel
  67
  68 * You may use the mailing list sonata-dev@lists.atosresearch.eu
  69 * Please use the GitHub issues to report bugs.