pygsti.protocols.protocol.ProtocolPostProcessor#

class ProtocolPostProcessor(name)#

Bases: object

Similar to a protocol, but runs on an existing ProtocolResults object.

Running a ProtocolPostProcessor produces a new (or updated) ProtocolResults object.

Parameters:

name (str) – The name of this post-processor.

Create a new ProtocolPostProcessor object.

Parameters:

name (str) – The name of this post-processor.

Return type:

ProtocolPostProcessor

Methods

__init__(name)

Create a new ProtocolPostProcessor object.

from_dir(dirname[, quick_load])

Initialize a new ProtocolPostProcessor object from dirname.

run(results[, memlimit, comm])

Run this post-processor on results.

write(dirname)

Write this protocol post-processor to a directory.

classmethod from_dir(dirname, quick_load=False)#

Initialize a new ProtocolPostProcessor object from dirname.

Parameters:
  • dirname (str) – The directory name.

  • quick_load (bool, optional) – Setting this to True skips the loading of components that may take a long time to load.

Return type:

ProtocolPostProcessor

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

Run this post-processor on results.

Parameters:
  • results (ProtocolResults) – The input results.

  • 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 post-processor in parallel.

Return type:

ProtocolResults

write(dirname)#

Write this protocol post-processor to a directory.

Parameters:

dirname (str) – The directory to write into.

Return type:

None