Skip to main content

Topology Types

Node/link definitions, generated topologies, topology snapshots, and diffing.

NodeDefinition

Quantum node (station or repeater).

NodeDefinition(id: str, memory_lifetime_t2: float)
FieldTypeDescription
idstrUnique node identifier
memory_lifetime_t2floatQubit T2 coherence time (s)

LinkDefinition

Physical quantum link between two nodes.

LinkDefinition(
from_node: str,
to: str,
distance_km: float,
base_fidelity: float,
generation_rate_hz: float,
link_type: Optional[LinkType] = LinkType.Fiber,
satellite_conditions: Optional[SatelliteConditions] = None,
)
FieldTypeDefaultDescription
from_nodestrSource node ID
tostrDestination node ID
distance_kmfloatPhysical distance (km)
base_fidelityfloatRaw link entanglement fidelity
generation_rate_hzfloatPhoton pair generation rate (Hz)
link_typeLinkTypeFiberPhysical medium
satellite_conditionsSatelliteConditionsNoneConditions if satellite link

NetworkTopologyPayload

Generated topology from generate_topology().

FieldTypeDescription
nodesList[NodeDefinition]Generated nodes
linksList[LinkDefinition]Generated links

TopologyEndpoints

Maps a generated topology name to its source and target nodes (used with compare_topologies).

TopologyEndpoints(topology_name: str, from_node: str, to_node: str)
FieldTypeDescription
topology_namestrPre-built topology name (telecom_backbone, repeater_chain, hybrid_satellite_fiber)
from_nodestrSource node ID within that topology
to_nodestrDestination node ID within that topology

TopologySnapshot

Topology snapshot used for programmatic diffing.

TopologySnapshot(
metadata: TopologyMetadata,
nodes: List[NodeDefinition],
links: List[LinkDefinition],
config: TopologyConfig,
)
FieldTypeDescription
metadataTopologyMetadataSnapshot metadata
nodesList[NodeDefinition]Nodes in this snapshot
linksList[LinkDefinition]Links in this snapshot
configTopologyConfigPhysics config for this snapshot

TopologyMetadata

Snapshot metadata.

TopologyMetadata(name: str, version: str)
FieldTypeDescription
namestrSnapshot name
versionstrSnapshot version

TopologyConfig

Snapshot physics configuration.

TopologyConfig(alpha_loss: float, gamma_swapping: float)
FieldTypeDescription
alpha_lossfloatAlpha loss parameter
gamma_swappingfloatGamma swapping parameter

TopologyDiff

Diff between two topology snapshots.

FieldTypeDescription
namestrDiff name
nodes_addedList[str]Nodes added in snapshot 2
nodes_removedList[str]Nodes removed from snapshot 1
nodes_modifiedList[str]Nodes modified between snapshots
links_addedList[str]Links added in snapshot 2
links_removedList[str]Links removed from snapshot 1
links_modifiedList[str]Links modified between snapshots
summarystrHuman-readable summary of the diff