You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
birdvisu/README.md

1.3 KiB

A simple tool for visualising OSPF network topology as seen by BIRD

Birdvisu is a library and a graphical app to visualize routing topologies of OSPF. It does not implement OSPF on its own, but rather exports current state from BIRD that's where the name comes from.

The main use case is comparing a reference topology (e.g. a known good one) to the current state. This allows Birdvisu to show failed links and other anomailes in the network.

Also, this is the project for my Bachelor thesis, which is available at https://gitea.ledoian.cz/LEdoian/bc_thesis.

Installation

Run pip install -e .. You can use a virtualenv if you wish (recommended).

Birdvisu can then be run just as visu. Other ways include running python -m birdvisu or ./visu.py from this directory, all of them are functionally equivalent.

Documentation

Documentation is built using Sphinx by running make in the docs/ directory.

Please read the thesis and/or comments and docstrings in the source code. While many things are explained, I haven't set up Sphinx yet, sorry.

Licence

I have not decided yet, so please ask for terms if you want to use this in some non-trivial way. Obviously this is source available :-)