Welcome to pyNTM’s documentation!

This is a network traffic modeler written in python 3. This library allows users to define a layer 3 network topology, define a traffic matrix, and then run a simulation to determine how the traffic will traverse the topology. If you’ve used Cariden MATE or WANDL, this code solves for some of the same basic use cases those do.

Changes to the topology can be done to simulate new routers, circuits, circuit capacity, network failures, etc. Changes to the traffic matrix can be done to simulate increases/decreases in existing traffic or additional traffic matrix entries.

Examine and run the client code examples, these docs, and check out the pyNTM training repository to get an understanding of how to use this code and the use cases.

For a network with hundreds of nodes and thousands of LSPs, it may take several minutes for the model to converge when update_simulation is called.

There are no implied or explicit warranties associated with this app.

Full API set use cases include

  • simulating how traffic will transit your layer 3 network, given a traffic matrix
  • simulating how your traffic will failover if any link(s) or node(s) fail
  • simulating how a given network augment will affect link utilization and traffic flow, possible augments include
    • adding a new link
    • adding a new node with links
    • changing a link’s capacity
    • adding a new traffic matrix entry (demand) to the traffic matrix
    • increasing/decreasing the magnitude of an existing demand in the traffic matrix failover

Note: interface circuit_ids are only used to match interfaces into circuits and do not have any practical bearing on the simulation results

Indices and tables