pygsti.protocols.protocol.ProtocolRunner

pygsti.protocols.protocol.ProtocolRunner#

class ProtocolRunner#

Bases: object

Used to run Protocol objects on an entire tree of data

This class provides a way of combining multiple calls to Protocol.run(), potentially running multiple protocols on different data. From the outside, a ProtocolRunner object behaves similarly, and can often be used interchangeably, with a Protocol object. It possesses a run method that takes a ProtocolData as input and returns a ProtocolResultsDir that can contain multiple ProtocolResults objects within it.

Methods

__init__()

run(data[, memlimit, comm])

Run all the protocols specified by this protocol-runner on data.

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

Run all the protocols specified by this protocol-runner on data.

Parameters:
  • data (ProtocolData) – The input data.

  • 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 protocol-runner in parallel.

Return type:

ProtocolResultsDir