pygsti.protocols.protocol.DataSimulator

pygsti.protocols.protocol.DataSimulator#

class DataSimulator#

Bases: object

An analysis routine that is run on an experiment design to produce per-circuit data.

A DataSimulator fundamentally simulates a model to create data, taking an ExperimentDesign as input and producing a ProtocolData object as output.

The produced data may consist of data counts for some/all of the circuit outcomes, and thus result in a ProtocolData containsing a normal DataSet. Alternatively, a data simulator may compute arbitrary quantities to be associated with the circuits, resulting in a ProtocolData containsing a normal FreeformDataSet.

Methods

__init__()

run(edesign[, memlimit, comm])

Run this data simulator on an experiment design.

run(edesign, memlimit=None, comm=None)#

Run this data simulator on an experiment design.

Parameters:
  • edesign (ExperimentDesign) – The input experiment design.

  • memlimit (int, optional) – A rough per-processor memory limit in bytes.

  • comm (mpi4py.MPI.Comm, optional) – When not None, an MPI communicator used to run this data simulator in parallel.

Return type:

ProtocolData