Feature/base qcvv framework (#992)

In preparation for the XEB/IRB benchmarking routines, this PR implements
some common functionality that can form the basis of a wide QCVV framework within
superstaq.

cirq-superstaq/cirq_superstaq/job.py

@@ -422,6 +422,20 @@ def __repr__(self) -> str:
     def _value_equality_values_(self) -> tuple[str, dict[str, Any]]:
         return self._job_id, self._job
 
+    def __getitem__(self, index: int) -> css.Job:
+        """Args:
+            idx: The index of the sub-job to return. Each sub-job corresponds to the a single
+                circuit.
+
+        Returns:
+            A sub-job at the given index.
+        """
+        job_id = self._job_id.split(",")[index]
+        sub_job = css.Job(self._client, job_id)
+        if job_id in self._job:
+            sub_job._job[job_id] = self._job[job_id]
+        return sub_job
+
 
 def _get_marginal_counts(counts: dict[str, int], indices: Sequence[int]) -> dict[str, int]:
     """Compute a marginal distribution, accumulating total counts on specific bits (by index).

cirq-superstaq/cirq_superstaq/job_test.py

@@ -54,6 +54,27 @@ def new_job() -> css.Job:
     return css.Job(client, "new_job_id")
 
 
+@pytest.fixture
+def multi_circuit_job() -> css.Job:
+    """Fixture for a job with multiple circuits submitted
+
+    Returns:
+        A job with multiple subjobs
+    """
+    client = gss.superstaq_client._SuperstaqClient(
+        client_name="cirq-superstaq",
+        remote_host="http://example.com",
+        api_key="to_my_heart",
+    )
+    job = css.Job(client, "job_id1,job_id2,job_id3")
+    job._job = {
+        "job_id1": {"status": "Done"},
+        "job_id2": {"status": "Running"},
+        "job_id3": {"status": "Submitted"},
+    }
+    return job
+
+
 def _mocked_request_response(content: object) -> requests.Response:
     response = requests.Response()
     response.status_code = requests.codes.OK
@@ -452,6 +473,13 @@ def test_job_results_poll_failure(mock_sleep: mock.MagicMock, job: css.job.Job)
     assert mock_sleep.call_count == 5
 
 
+def test_job_getitem(multi_circuit_job: css.job.Job) -> None:
+    job_1 = multi_circuit_job[0]
+    assert isinstance(job_1, css.Job)
+    assert job_1.job_id() == "job_id1"
+    assert job_1.status() == "Done"
+
+
 def test_get_marginal_counts() -> None:
     counts_dict = {"10": 50, "11": 50}
     indices = [0]

docs/source/index.rst

@@ -6,7 +6,7 @@
 Superstaq Documentation
 =======================
 Welcome! Here you can find more about Infleqtion's state-of-the-art quantum software platform that uses proprietary cross-layer optimization techniques to deliver unmatched performance.
-      
+
 .. raw:: html
 
    <div class="container-index">

supermarq-benchmarks/examples/qcvv/qcvv.rst

@@ -0,0 +1,12 @@
+QCVV: Quantum Characterisation, Validation and Verification
+===========================================================
+
+The Supermarq QCVV library provides a customizable toolkit for testing and characterizing
+quantum devices. The toolkit can either be used with simulators or on live devices.
+
+For a demonstration of how to implement a new experiment take a look at the following notebook
+
+.. toctree::
+    :maxdepth: 1
+
+    qcvv_css

supermarq-benchmarks/requirements.txt

@@ -1,3 +1,4 @@
 cirq-superstaq~=0.5.23
 qiskit-superstaq~=0.5.23
 scikit-learn>=1.0
+seaborn>=0.13.2

supermarq-benchmarks/supermarq/__init__.py

@@ -1,4 +1,4 @@
-from . import benchmark, converters, features, plotting, simulation, stabilizers
+from . import benchmark, converters, features, plotting, qcvv, simulation, stabilizers
 from ._version import __version__
 from .benchmarks import (
     bit_code,
@@ -27,4 +27,5 @@
     "simulation",
     "stabilizers",
     "vqe_proxy",
+    "qcvv",
 ]

supermarq-benchmarks/supermarq/qcvv/__init__.py

@@ -0,0 +1,5 @@
+"""A toolkit of QCVV routines."""
+
+from .base_experiment import BenchmarkingExperiment, BenchmarkingResults, Sample
+
+__all__ = ["BenchmarkingExperiment", "BenchmarkingResults", "Sample"]