Skip to content

nitk-nest/NeST

Repository files navigation

NeST: Network Stack Tester

pipeline status

NeST is a python3 package that handles testbed setup, testbed configuration, collecting and visualizing data by providing a user friendly API, addressing common issues involved in conducting networking experiments.

The paper introducing NeST was accepted at ANRW'20.

NeST source code repository is maintained at GitLab.

NOTE: NeST is currently in beta stage.

Installation

Instructions to install NeST can be found in install.rst.

Examples

Several examples, that explain the basic APIs and features of NeST, are available in the examples directory.

Documentation

The documentation of NeST APIs can be read online at: https://nest.nitk.ac.in/docs/

Instructions for generating/building the API documentation can be found in docs/README.md folder.

Unit tests

Tests can be found in nest/tests folder. Run the below command in the repo's root folder to run the tests.

sudo python3 -m unittest -v

NOTE: NeST requires root access currently to create and manage network namespaces.

Contributing

To contribute, read CONTRIBUTING.md