QKDpy
Contents:
Installation
Using uv (recommended)
Using pip
Optional Extras
Product Tiers
Verify Installation
Quick Start
Density Matrix & Circuit
Enterprise Quick Start
API Reference
Setup
Protocols
BB84 — Standard Prepare-and-Measure
E91 — Entanglement-Based (Bell Pairs)
B92 — Minimal Two-State Protocol
SARG04 — Four-State with Stronger Basis Guarantee
Six-State — Three-Basis Protocol
Decoy-State BB84 — PNS-Resistant
CV-QKD — Continuous-Variable
Enhanced CV-QKD — Reconciliation-Enhanced
HD-QKD — High-Dimensional Qudits
MDI-QKD — Measurement-Device-Independent
DI-QKD — Device-Independent (Self-Testing)
Twisted Pair QKD — Three-Basis Protocol
SecretKeyRate — Key Rate Calculator
ChannelParameters
DecoyStateParameters
Finite Key Analysis
FiniteKeyParameters
Core Quantum Stack
Qubit
Qudit — Higher-Dimensional States
DensityMatrix
Circuit
CPTP Channels
QuantumGate
MultiQubitState — Entanglement
Measurement Utilities
Channel Statistics & Eavesdropping
Key Management
Error Correction
Privacy Amplification
Key Distillation Pipeline
QuantumKeyManager — Full Lifecycle
Quantum Error Correction (QEC)
Network & Satellite QKD
SatelliteQKD — LEO/MEO/GEO Pass Simulation
Different Orbit Types
FreeSpaceOpticalChannel — Satellite-Ground Link
Atmospheric Physics Helpers
QuantumNetwork — Multi-Node Topologies
Multi-Party QKD
ML Optimization
QKDOptimizer — Bayesian, Genetic & Neural Methods
EfficientQKDPredictor — Lightweight Edge Deployment
QKDAnomalyDetector
Enterprise Features
Tier Activation
HSM Interface
Audit Logger
Compliance Checking
Quantum-Safe Migration Toolkit
Observability
OperationSpan — Timed Context Manager
@instrument Decorator
Domain-Specific Recording Helpers
Logging Configuration
Validation Helpers
Utility Helpers
Framework Integrations
Integration Detection
Qiskit Integration
Cirq Integration
PennyLane Integration
QpiAI Integration
Crypto
Configuration
Examples
Advanced Protocol Usage
Density Matrix & Circuit
Secret Key Rate Computation
Observability & Instrumentation
Enterprise Compliance Checking
Quantum-Safe Migration Toolkit
Product Tier Gating
Product Tier Model — Public Overview
Context
Decision
Consequences
Public capabilities by tier
Observability & Instrumentation — Public Overview
Context
Decision
Consequences
Roadmap — What’s Next for QKDpy
Themes we’re investing in
How we sequence the work
What QKDpy is
not
claiming
Diagrams:
High-Level Architecture
Protocol Execution Flow
Core Quantum Stack
Key Management Pipeline
Network & Satellite QKD
Integration Layer
Crypto & Enterprise
ML Optimization
Data Flow
API Surface
QKDpy
API Surface
API Surface
