Welcome to Topolib’s documentation!

Topolib is a compact Python library for modeling, analyzing, and visualizing optical network topologies. It provides a clean, object-oriented API for nodes, links, topologies, metrics, and visualization tools, making it ideal for research, teaching, and rapid prototyping in network science and engineering.

Key features:

  • Modular design: elements, topology, analysis, and visualization

  • Easy-to-use classes for nodes, links, and paths

  • Built-in metrics and analysis helpers

  • JSON import/export and interoperability

  • Ready for integration with Sphinx, Read the Docs, and PyPI

Get started by exploring the modules below, or see the README for quick usage examples.

Note

This documentation is generated automatically from the source code and is always up to date with the latest release.