Skip to main content

Protocols

Three higher-level quantum networking protocols available as both engine methods and module-level convenience functions.

QKD (Quantum Key Distribution)

BB84-style protocol for secure key exchange between two nodes.

QKDParameters

FieldTypeDefaultDescription
from_nodestrSource node ID
to_nodestrDestination node ID
fidelity_targetfloatRequired entanglement fidelity
max_latency_msfloatMaximum allowed latency (ms)
roundsint100Number of QKD rounds
error_rate_tolerancefloat0.11BB84 error threshold
sifting_overhead_ratiofloat0.5Public sifting overhead
privacy_amplification_factorfloat0.8Privacy amplification factor

QKDResult

FieldTypeDescription
successboolWhether secure key was established
secret_key_length_bitsintLength of generated secret key (bits)
efficiency_ratefloatKey generation efficiency [0, 1]
qberfloatQuantum bit error rate
latency_msfloatTotal protocol latency (ms)
execution_pathList[str]Node IDs traversed
rounds_completedintNumber of successful rounds
rounds_failedintNumber of failed rounds

QKDStats (Monte Carlo ensemble)

Note: Monte Carlo ensemble for QKD is planned but not yet implemented. run_qkd() currently returns a single QKDResult.

FieldTypeDescription
total_runsintNumber of QKD runs executed
success_ratefloatFraction of successful runs [0, 1]
mean_key_length_bitsfloatMean secret key length (bits)
mean_efficiencyfloatMean key generation efficiency
mean_qberfloatMean quantum bit error rate

Teleportation

Entanglement-based quantum state teleportation across the network.

TeleportationParameters

FieldTypeDefaultDescription
source_nodestrSource node (Alice)
target_nodestrTarget node (Bob)
state_fidelityfloat0.95Input state fidelity
classical_bandwidth_msfloat100.0Classical channel latency (ms)
relay_nodesList[str][]Intermediate relay node IDs

TeleportationOutcome

FieldTypeDescription
successboolWhether teleportation succeeded
teleportation_fidelityfloatFidelity of teleported state
resource_entanglement_fidelityfloatFidelity of resource entanglement links
latency_msfloatEnd-to-end latency (ms)
pathList[str]Node IDs traversed
classical_bits_transferredintNumber of classical bits sent

TeleportationStats (Monte Carlo ensemble)

Note: Monte Carlo ensemble for teleportation is planned but not yet implemented. execute_teleportation() currently returns a single TeleportationOutcome.

FieldTypeDescription
total_runsintNumber of teleportation runs executed
success_ratefloatFraction of successful runs [0, 1]
mean_teleportation_fidelityfloatMean teleportation fidelity
teleportation_fidelity_stddevfloatStandard deviation of teleportation fidelity
mean_latency_msfloatMean end-to-end latency (ms)

Distributed Quantum Computing

Multi-party quantum computation with coordinated measurements. Supports star, ring, mesh, and arbitrary topologies with GHZ / cluster / graph measurement bases.

DistributedComputingParameters

FieldTypeDefaultDescription
participantsList[str]Participant node IDs
coordination_topologyCoordinationTopologyCoordination pattern
measurement_basisMeasurementBasisGHZ, 0.85Measurement basis config
classical_relay_latency_msfloat5.0Classical relay latency (ms)

DistributedComputingResult

FieldTypeDescription
successboolWhether computation succeeded
computation_fidelityfloatFidelity of the distributed computation
party_resultsList[PartyOutcome]Per-party measurement outcomes
resource_links_usedList[str]Links used during protocol
total_latency_msfloatEnd-to-end latency (ms)
coordination_overhead_msfloatCoordination overhead (ms)

PartyOutcome

FieldTypeDescription
node_idstrParticipant node ID
successful_measurementboolWhether measurement succeeded
local_fidelityfloatLocal measurement fidelity

DistributedComputingStats (Monte Carlo ensemble)

Note: Monte Carlo ensemble for distributed computation is planned but not yet implemented. run_distributed_computation() currently returns a single DistributedComputingResult.

FieldTypeDescription
total_runsintNumber of runs executed
success_ratefloatFraction of successful runs [0, 1]
mean_computation_fidelityfloatMean computation fidelity
mean_coordination_overhead_msfloatMean coordination overhead (ms)

MeasurementBasis

Measurement basis configuration for distributed protocols.

MeasurementBasis(basis_type: BasisType, correlation_strength: float = 0.85)
FieldTypeDefaultDescription
basis_typeBasisTypeMeasurement basis (GHZ, Cluster, GraphGraph)
correlation_strengthfloat0.85Correlation strength parameter

CoordinationTopology

Party coordination pattern with static factory methods.

Method/FieldSignature / TypeDescription
.star(center_node)(str) -> CoordinationTopologyStar topology with center node
.ring()() -> CoordinationTopologyRing topology (circular)
.mesh()() -> CoordinationTopologyAll-to-all mesh topology
.arbitrary(edges)((src, dst), ...) -> CoordinationTopologyCustom edges list
kindstr"star", "ring", "mesh", or "arbitrary"
center_nodeOptional[str]Center node for star (optional)
edgesOptional[List[tuple]]Edge list for arbitrary (optional)