pygsti.protocols.protocol.DataSimulator#
- class DataSimulator#
Bases:
objectAn 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
ExperimentDesignas input and producing aProtocolDataobject as output.The produced data may consist of data counts for some/all of the circuit outcomes, and thus result in a
ProtocolDatacontainsing a normalDataSet. Alternatively, a data simulator may compute arbitrary quantities to be associated with the circuits, resulting in aProtocolDatacontainsing a normalFreeformDataSet.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: