Installation

Python Version

DigSiNet requires that you use a Python version that is greater or equal to version 3.10. Please refer to the Python Documentation in order to install a compatible version.

Dependencies

Before installing DigSiNet, make sure that you provide all necessary dependencies. At the current point of writing, the Dependencies are:

Docker DigSiNet currently uses containerized network operating systems for Siblings.
Containerlab Provides a CLI for orchestrating and managing container based networking labs. DigSiNet uses containerlab to build Siblings.

Optional Dependencies

Dependencies here are not necessary for running DigSiNet, but may allow to run more of the provided examples. This is because some examples rely on container images that are not publicly available, but you can usually retrieve them yourself.

Arista cEOS Container Image Some examples use cEOS from Arista. The container image is not publicly available, but you can create an account at Arista and download it from there.

Virtual Environments

We recommend using a virtual environment (venv) to manage the package dependencies of DigSiNet. Virtual environments greatly simplify dealing with python dependencies by providing an isolated group of python packages specifically for one application.

Fortunately, Python comes with the functionality to create virtual environments by default.

Create venv

Create a folder for DigSiNet and initialize a new virtual environment in it:

$ mkdir digsinet
$ cd digsinet
$ python3 -m venv .venv

Activate venv

Before we can continue with the installation, we need to explicitly activate the previously created virtual environment:

$ source .venv/bin/activate

You will see that the virtual environment is activated by looking at your command prompt.

Install DigSiNet

You will need to clone the DigSiNet repository from GitHub:

$ git clone https://github.com/srieger1/digsinet .

After you have successfully cloned the repository, you can install required packages:

$ pip install -r ./requirements.txt

You are now ready to run DigSiNet. We provide some example configurations to play around with. You can find more information in our Getting Started.