Skip to main content

Result Types

Output types for simulations, ensemble runs, and topology comparisons.

SimulationResult

Output from a single request_entanglement() call.

SimulationResult(success: bool, latency_ms: float, final_fidelity: float, execution_path: List[str])
FieldTypeDescription
successboolWhether entanglement was established
latency_msfloatEnd-to-end latency (ms)
final_fidelityfloatFinal entangled state fidelity
execution_pathList[str]Node IDs traversed (inclusive)

MonteCarloStats

Output from a simulate() ensemble run.

MonteCarloStats(
total_runs: int,
empirical_success_rate: float,
mean_latency_ms: float,
mean_fidelity: float,
aggregate_congestion_drops: int,
link_utilization_heatmap: Dict[str, int],
)
FieldTypeDescription
total_runsintNumber of simulation runs executed
empirical_success_ratefloatFraction of successful runs [0, 1]
mean_latency_msfloatMean latency across all runs (ms)
mean_fidelityfloatMean fidelity across successful runs
aggregate_congestion_dropsintTotal drops due to qubit memory expiry
link_utilization_heatmapDict[str, int]{link_key: usage_count} per link

TopologyComparisonReport

Output from compare_topologies().

FieldTypeDescription
source_nodestrSource node used for comparison
target_nodestrTarget node used for comparison
fidelity_targetfloatFidelity target used
max_latency_msfloatMax latency used
runsintNumber of Monte Carlo runs per topology
resultsList[TopologyComparisonResult]Per-topology results
recommended_topologystrBest topology by success rate
summarystrHuman-readable summary

TopologyComparisonResult

Per-topology result within a TopologyComparisonReport.

FieldTypeDescription
topology_namestrName of the compared topology
success_ratefloatFraction of successful runs [0, 1]
mean_latency_msfloatMean latency (ms)
mean_fidelityfloatMean fidelity
link_utilizationLink utilization data