netgraph-core 0.2.2

C++ implementation of graph algorithms for network flow analysis and traffic engineering with Python bindings

NetGraph-Core

C++ graph engine for network flow analysis, traffic engineering simulation, and capacity planning.

Overview

NetGraph-Core provides a specialized graph implementation for networking problems. Key design priorities:

• Determinism: Guaranteed reproducible edge ordering by (cost, src, dst).
• Flow Modeling: Native support for multi-commodity flow state, residual tracking, and ECMP/WCMP placement.
• Performance: Immutable CSR (Compressed Sparse Row) adjacency and zero-copy NumPy views.

Core Features

1. Graph Representations

• StrictMultiDiGraph: Immutable directed multigraph using CSR adjacency. Supports parallel edges (multi-graph), essential for network topologies.
• FlowGraph: Topology overlay managing mutable flow state, per-flow edge allocations, and residual capacities.

2. Network Algorithms

• Shortest Paths (SPF):

  • Modified Dijkstra returns a Predecessor DAG to capture all equal-cost paths.
  • Supports ECMP (Equal-Cost Multi-Path) routing.
  • Features node/edge masking and residual-aware tie-breaking.

• K-Shortest Paths (KSP):

  • Yen's algorithm returning DAG-wrapped paths.
  • Configurable constraints on cost factors (e.g., paths within 1.5x of optimal).

• Max-Flow:

  • Algorithm: Iterative augmentation using Successive Shortest Path on residual graphs, pushing flow across full ECMP/WCMP DAGs at each step.
  • Traffic Engineering (TE) Mode: Routing adapts to residual capacity (progressive fill).
  • IP Routing Mode: Cost-only routing (ECMP/WCMP) ignoring capacity constraints.

• Analysis:

  • Sensitivity Analysis: Identifies bottleneck edges where capacity relaxation increases total flow. Supports shortest_path mode to analyze only edges used under ECMP routing (IP/IGP networks) vs. full max-flow (SDN/TE networks).
  • Min-Cut: Computes minimum cuts on residual graphs.

3. Flow Policy Engine

Unified configuration object (FlowPolicy) that models diverse routing behaviors:

• Modeling: Unified configuration for IP Routing (static costs) and Traffic Engineering (dynamic residuals).
• Placement Strategies:
  • EqualBalanced: ECMP (equal splitting) - equal distribution across next-hops and parallel edges.
  • Proportional: WCMP (weighted splitting) - distribution proportional to residual capacity.
• Lifecycle Management: Handles demand placement, re-optimization of existing flows, and constraints (path cost, stretch factor, flow counts).

4. Python Integration

• Zero-Copy: Exposes C++ internal buffers to Python as read-only NumPy arrays (float64/int64).
• Concurrency: Releases the Python GIL during graph algorithms to enable threading.

Installation

pip install netgraph-core

Or from source:

pip install -e .

Repository Structure

src/                    # C++ implementation
include/netgraph/core/  # Public C++ headers
bindings/python/        # pybind11 bindings
python/netgraph_core/   # Python package
tests/cpp/              # C++ tests (googletest)
tests/py/               # Python tests (pytest)

Development

make dev        # Setup: venv, dependencies, pre-commit hooks
make check      # Run all tests and linting (auto-fix formatting)
make check-ci   # Strict checks without auto-fix (for CI)
make cpp-test   # C++ tests only
make py-test    # Python tests only
make cov        # Coverage report (C++ + Python)

Requirements

• C++: C++20 compiler (GCC 10+, Clang 12+, MSVC 2019+)
• Python: 3.9+
• Build: CMake 3.15+, scikit-build-core
• Dependencies: pybind11, NumPy

License

AGPL-3.0-or-later