diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 13 insertions, 2 deletions
@@ -24,6 +24,7 @@ pip install . Optional extras: ```bash +pip install rumba[docker] # Docker testbed backend pip install rumba[NumpyAcceleration] # faster random traffic generation pip install rumba[graphs] # PDF graph export via pydot pip install rumba[visualizer] # interactive visualization via igraph + plotly @@ -35,8 +36,7 @@ On Debian/Ubuntu you may also need: sudo apt-get install build-essential libssl-dev libffi-dev python3-dev ``` -The required dependencies (`paramiko` and `docker`) are installed -automatically. +The required dependency (`paramiko`) is installed automatically. ## Defining a Topology @@ -200,6 +200,17 @@ If you use Rumba in your research, please cite: > "Rumba: A Python framework for automating large-scale recursive > internet experiments on GENI and FIRE+," *IEEE*, 2018. +## Versioning + +Rumba uses `setuptools_scm` to derive its version from git tags. + +**Compatibility contract across Ouroboros repositories:** + +| Scope | Rule | +|---|---| +| ouroboros (C) ↔ pyouroboros / rumba | Shared `major.minor` — rumba requires at least the same ouroboros `major.minor` | +| pyouroboros ↔ rumba ↔ ouroboros-integration | Strict lockstep `major.minor.patch` — always released together | + ## License Rumba is licensed under the |