Welcome to SixGman’s Documentation!#
SixGman is a Python-based toolkit for optical network modeling, planning, and simulation. It is designed for researchers, telecom engineers, and students working in optical communication networks.
With SixGman, you can:
🏗 Model optical networks with nodes, links, and multiple wavelength bands
📊 Analyze optical performance with configurable physical parameters
📡 Plan traffic routing & capacity allocation for large-scale networks
🎨 Visualize simulation results to support network design and optimization
Key Features#
Network Modeling – Define nodes, links, and real/synthetic topologies
Optical Band Management – Handle C-band, L-band, or custom bands
Planning & Simulation - Compute SNR/OSNR and required margins - Simulate traffic routing & wavelength assignment (RWA) - Evaluate network KPIs for multi-band scenarios
Visualization Tools for network and performance metrics
Ready for Research & Teaching – Easy to extend and integrate into experiments
Note
This documentation is under active development.
Project Structure#
sixgman/
├── src/sixgman/core # Core classes: Network, Band, PlanningTool
├── src/sixgman/utils # Utility functions and path handling
├── tests/ # Unit tests for each module
├── examples/ # Jupyter notebooks for simulation examples
├── data/ # Example data files (.mat, .npz)
├── results/ # Generated results and network KPIs
Contents#
Getting Started
User Guide
Contributing
Project Info
Contact#
Maintainers: Matin Rafiei Forooshani, Farhad Arpanaei
📧 Email: - matinrafiei007@gmail.com - farhad.arpanaei@OS.es