test_qis.py

import pytest
from pathlib import Path

import yaml
from selene_sim.event_hooks import CircuitExtractor, MetricStore, MultiEventHook
from selene_sim import Quest
from selene_sim.build import build
from selene_helios_qis_plugin import HeliosInterface
from selene_sol_qis_plugin import SolInterface

RESOURCE_DIR = Path(__file__).parent / "resources"
QIS_RESOURCE_DIR = RESOURCE_DIR / "qis"


@pytest.mark.parametrize(
    "program_name",
    [
        "add_3_11",
    ],
)
def test_qis(snapshot, program_name: str):
    filename = f"{program_name}-any.ll"
    helios_file = QIS_RESOURCE_DIR / "helios" / filename
    sol_file = QIS_RESOURCE_DIR / "sol" / filename
    assert helios_file.exists()
    assert sol_file.exists()

    helios_build = build(helios_file, interface=HeliosInterface())
    sol_build = build(sol_file, interface=SolInterface())

    helios_results = helios_build.run_shots(
        Quest(), n_qubits=10, n_shots=100, random_seed=1024
    )

    sol_results = sol_build.run_shots(
        Quest(), n_qubits=10, n_shots=100, random_seed=1024
    )

    results = {
        "helios": list(list(shot) for shot in helios_results),
        "sol": list(list(shot) for shot in sol_results),
    }

    assert results["helios"] == results["sol"]

    snapshot.assert_match(yaml.dump(results), f"{program_name}.yaml")


@pytest.mark.parametrize(
    "program_name",
    [
        "add_3_11",
    ],
)
def test_qis_circuit_log(snapshot, program_name: str):
    filename = f"{program_name}-any.ll"
    helios_file = QIS_RESOURCE_DIR / "helios" / filename
    sol_file = QIS_RESOURCE_DIR / "sol" / filename
    assert helios_file.exists()
    assert sol_file.exists()

    helios_build = build(helios_file, interface=HeliosInterface())
    sol_build = build(sol_file, interface=SolInterface())

    helios_circuit_extractor = CircuitExtractor()
    sol_circuit_extractor = CircuitExtractor()

    helios_results = helios_build.run_shots(
        Quest(),
        n_qubits=10,
        n_shots=1,
        random_seed=1024,
        event_hook=helios_circuit_extractor,
    )

    sol_results = sol_build.run_shots(
        Quest(),
        n_qubits=10,
        n_shots=1,
        random_seed=1024,
        event_hook=sol_circuit_extractor,
    )

    # trigger shot consumption
    list(list(shot) for shot in helios_results)
    list(list(shot) for shot in sol_results)

    circuits = {
        "helios": repr(helios_circuit_extractor.shots[0].get_user_circuit()),
        "sol": repr(sol_circuit_extractor.shots[0].get_user_circuit()),
    }

    snapshot.assert_match(yaml.dump(circuits), f"{program_name}_circuits.yaml")


def test_simulate_delay():
    filename = "simulate_delay-any.ll"
    helios_file = QIS_RESOURCE_DIR / "helios" / filename
    assert helios_file.exists()
    helios_build = build(helios_file, interface=HeliosInterface())
    helios_circuit_extractor = CircuitExtractor()
    metric_store = MetricStore()
    hook = MultiEventHook([helios_circuit_extractor, metric_store])

    helios_results = helios_build.run_shots(
        Quest(),
        n_qubits=2,
        n_shots=1,
        random_seed=1024,
        event_hook=hook,
    )

    results = {
        "helios": list(dict(shot) for shot in helios_results),
    }
    assert results["helios"][0]["qubit_0"] == 0
    assert results["helios"][0]["qubit_1"] == 0

    shot_metrics = metric_store.shots[0]
    # the QIS example adds a simulated delay of 123,450,000 ns, so we check that the metric store reflects this
    # in the total runtime (the default "simple" runtime doesn't add any time taken for operations)
    assert shot_metrics["post_runtime"]["total_duration_ns"] == 1_234_500_000, (
        f"Expected total_duration_ns to be 1,234,500,000 ns, but got {shot_metrics['post_runtime']['total_duration_ns']}"
    )

    optimiser_output = helios_circuit_extractor.shots[0].get_optimiser_output()

    assert optimiser_output == [
        {"op": "BatchStart", "start_time_ns": 0, "duration_ns": 0},
        {"op": "Reset", "qubit": 0},
        {"op": "BatchStart", "start_time_ns": 0, "duration_ns": 0},
        {"op": "Reset", "qubit": 1},
        {"op": "BatchStart", "start_time_ns": 0, "duration_ns": 0},
        {"op": "FutureRead", "qubit": 0},
        # simulated delay happens here, so we expect the next operations to be logged as starting at 1,234,500,000 ns
        {"op": "BatchStart", "start_time_ns": 1234500000, "duration_ns": 0},
        {"op": "FutureRead", "qubit": 1},
    ]

    all_output = list(helios_circuit_extractor.shots[0])
    all_output_serialised = []
    for item in all_output:
        if str(item.source) not in {"Source.USER", "Source.OPTIMISER"}:
            continue
        all_output_serialised.append(
            {"source": str(item.source), "operation": item.operation.to_dict()}
        )

    assert all_output_serialised == [
        {
            "operation": {
                "op": "QAlloc",
                "qubit": 0,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "op": "QAlloc",
                "qubit": 1,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "op": "Reset",
                "qubit": 0,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "duration_ns": 0,
                "op": "BatchStart",
                "start_time_ns": 0,
            },
            "source": "Source.OPTIMISER",
        },
        {
            "operation": {
                "op": "Reset",
                "qubit": 0,
            },
            "source": "Source.OPTIMISER",
        },
        {
            "operation": {
                "op": "Reset",
                "qubit": 1,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "duration_ns": 0,
                "op": "BatchStart",
                "start_time_ns": 0,
            },
            "source": "Source.OPTIMISER",
        },
        {
            "operation": {
                "op": "Reset",
                "qubit": 1,
            },
            "source": "Source.OPTIMISER",
        },
        {
            "operation": {
                "op": "MeasureRequest",
                "qubit": 0,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "duration_ns": 0,
                "op": "BatchStart",
                "start_time_ns": 0,
            },
            "source": "Source.OPTIMISER",
        },
        {
            "operation": {
                "op": "FutureRead",
                "qubit": 0,
            },
            "source": "Source.OPTIMISER",
        },
        {
            "operation": {
                "op": "QFree",
                "qubit": 0,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "op": "FutureRead",
                "qubit": 0,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "duration_ns": 1234500000,
                "op": "ClassicalDelay",
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "op": "MeasureRequest",
                "qubit": 1,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "duration_ns": 0,
                "op": "BatchStart",
                "start_time_ns": 1234500000,
            },
            "source": "Source.OPTIMISER",
        },
        {
            "operation": {
                "op": "FutureRead",
                "qubit": 1,
            },
            "source": "Source.OPTIMISER",
        },
        {
            "operation": {
                "op": "QFree",
                "qubit": 1,
            },
            "source": "Source.USER",
        },
        {
            "operation": {
                "op": "FutureRead",
                "qubit": 1,
            },
            "source": "Source.USER",
        },
    ]