API Reference
Python SDK for qnet-core — quantum network simulation engine.
Contents
Core Engine
- QNetEngine — Main simulation entry point, constructor and all methods
- SimulationConfig / PhysicalConfig — Timeline and physical-layer configuration types
Enums
- StrategyType — Routing strategy (LowestLatency, HighestFidelity, HighestSuccess)
- LinkType — Physical medium enum (Fiber / Satellite)
- QNetNodeType — Node classification (.qnet: Ground, Satellite, Repeater)
- QNetLinkType — Link classification (.qnet: Fiber, Satellite)
- BasisType — Measurement basis for distributed protocols (GHZ, Cluster, GraphGraph)
Types
- Topology Types — NodeDefinition, LinkDefinition, NetworkTopologyPayload, TopologyEndpoints, TopologySnapshot, TopologyMetadata, TopologyConfig, TopologyDiff
- Result Types — SimulationResult, MonteCarloStats, TopologyComparisonReport, TopologyComparisonResult
- .qnet Container Types — QNetFile, QNetNode, QNetLink, QNetConfig, QNetConstraints, QNetMetadata, QNetSatelliteExtension
Protocols
- QKD (Quantum Key Distribution) — QKDParameters, QKDResult, QKDStats
- Teleportation — TeleportationParameters, TeleportationOutcome, TeleportationStats
- Distributed Computing — DistributedComputingParameters, DistributedComputingResult, PartyOutcome, DistributedComputingStats, MeasurementBasis, CoordinationTopology
Convenience Functions
- Module-level Functions — 12 convenience functions (from_qnet_file, generate_topology, compare_topologies, save/load_topology, validate, load_qnet_file, diff, diff_topologies, qkd, teleportation, distributed_computation)
Summary
| Category | Count |
|---|---|
| Classes | 32 |
| Module-level functions | 12 |
| Enums | 5 (StrategyType, LinkType, QNetNodeType, QNetLinkType, BasisType) |