From 6b9bf57784ccc3da1ef80eb50ec37897b19ccb07 Mon Sep 17 00:00:00 2001 From: peusterm Date: Fri, 8 Jul 2016 15:06:12 +0200 Subject: [PATCH] readme --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 43cfa91..734fad6 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,13 @@ [![Build Status](http://jenkins.sonata-nfv.eu/buildStatus/icon?job=son-emu)](http://jenkins.sonata-nfv.eu/job/son-emu) # son-emu -Here comes a brief description of the repository and the code inside. +This is the repository of [SONATA's](http://sonata-nfv.eu) emulation platform. + +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. + +More details about the the emulator's architecture and concepts can be found in the following publication: + +* 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). ## Development (if applicable) @@ -10,25 +16,24 @@ Here comes a brief description of the repository and the code inside. Describe briefly how to build the software. ### Dependencies -Name all the dependencies needed by the software, including version, license (!), and a link. For example -* [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL) -* [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT) -* [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain) * [argparse](https://pypi.python.org/pypi/argparse) >= 1.4.0 (Python software foundation License) -* [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11 (BSD) -* [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT) -* [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0) -* [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0 (Apache 2.0) -* [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT) -* [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT) +* [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(Apache 2.0) * [Flask](https://pypi.python.org/pypi/Flask) >= 0.11 (BSD) * [flask_restful](https://pypi.python.org/pypi/Flask-RESTful) >= 0.3 (BSD) -* [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0) -* [docker-py](https://pypi.python.org/pypi/docker-py) == 1.7.1(Apache 2.0) +* [networkx](https://pypi.python.org/pypi/networkx/) >= 1.11 (BSD) +* [oslo.config](http://docs.openstack.org/developer/oslo.config/) >= 3.9.0 (Apache 2.0) * [paramiko](https://pypi.python.org/pypi/paramiko/1.16.0) >= 1.6 (LGPL) * [prometheus_client](https://pypi.python.org/pypi/prometheus_client) >= 0.0.13 (Apache 2.0) +* [pyaml](https://pypi.python.org/pypi/pyaml) >=15.8.2 (WTFPL) +* [pytest-runner](https://pypi.python.org/pypi/pytest-runner) >= 2.8 (MIT) +* [pytest](https://pypi.python.org/pypi/pytest) >= 2.9 (MIT) +* [requests](https://pypi.python.org/pypi/requests) >= 2.10 (Apache 2.0) +* [ryu](https://pypi.python.org/pypi/ryu/4.4) >= 4.4 (Apache 2.0) +* [six](https://pypi.python.org/pypi/six/) >=1.9 (MIT) +* [tabulate](https://pypi.python.org/pypi/tabulate) >= 0.7.5 (public domain) * [urllib3](https://pypi.python.org/pypi/urllib3) >= 1.15 (MIT) +* [zerorpc](http://www.zerorpc.io) >= 0.5.2 (MIT) ### Contributing (if applicable) Description (encouraging) how to contribute to this project/repository. -- 2.25.1