supermarq.qcvv.ssb
==================

.. py:module:: supermarq.qcvv.ssb

.. autoapi-nested-parse::

   Tooling for Symmetric Stabilizer Benchmarking.
   See https://arxiv.org/pdf/2407.20184 for more details.



Classes
-------

.. autoapisummary::

   supermarq.qcvv.ssb.SSB
   supermarq.qcvv.ssb.SSBResults


Module Contents
---------------

.. py:class:: SSB(num_circuits: int, cycle_depths: collections.abc.Iterable[int], *, random_seed: int | numpy.random.Generator | None = None, _samples: list[supermarq.qcvv.base_experiment.Sample] | None = None, **kwargs: str)

   Bases: :py:obj:`supermarq.qcvv.base_experiment.QCVVExperiment`\ [\ :py:obj:`SSBResults`\ ]


   Symmetric Stabilizer Benchmarking. A benchmarking algorithm for determining the CZ fidelity
   of a device. Specifically designed for neutral atom devices where CZ-gates mediated by Rydberg
   interactions are the native entangling gate.

   See: https://arxiv.org/abs/2407.20184


.. py:class:: SSBResults

   Bases: :py:obj:`supermarq.qcvv.base_experiment.QCVVResults`


   Results from an SSB experiment.


   .. py:method:: plot_results(filename: str | None = None) -> matplotlib.pyplot.Figure

      Plot the experiment data and the corresponding fits. The shaded upper and lower limits
      of the shaded region indicate the fits at +/- 1 standard deviation in all fitted parameters.

      :param filename: Optional argument providing a filename to save the plots to. Defaults to None,
                       indicating not to save the plot.

      :returns: A single matplotlib figure with the experimental data and corresponding fits.

      :raises RuntimeError: If there is no data stored.



   .. py:property:: cz_fidelity_estimate
      :type: float


      Estimated CZ fidelity.


   .. py:property:: cz_fidelity_estimate_std
      :type: float


      Standard deviation for the CZ fidelity estimate.