pygsti.protocols.protocol

pygsti.protocols.protocol#

Protocol object

Functions

run_default_protocols(data[, memlimit, comm])

Run the default protocols for the data-tree rooted at data.

Classes

CanCreateAllCircuitsDesign([circuits, ...])

A type of ExperimentDesign that can create all_circuits_needing_data from subdesigns or other information.

CircuitListsDesign(circuit_lists[, ...])

Experiment design specification that is comprised of multiple circuit lists.

CombinedExperimentDesign(sub_designs[, ...])

An experiment design that combines the specifications of one or more "sub-designs".

DataCountsSimulator(model[, num_samples, ...])

Simulates data counts for each circuit outcome, producing a simulated data set.

DataSimulator()

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

DefaultRunner([run_passes_separately])

Run the default protocol at each data-tree node.

ExperimentDesign([circuits, qubit_labels, ...])

An experimental-design specification for one or more QCVV protocols.

FreeformDesign(circuits[, qubit_labels])

Experiment design holding an arbitrary circuit list and meta data.

MultiPassProtocol(protocol[, name])

Runs a (contained) Protocol on all the passes of a multi-pass ProtocolData.

MultiPassResults(data, protocol_instance)

Holds the results of a single protocol on multiple "passes" (sets of data, typically taken at different times).

Protocol([name])

An analysis routine that is run on experimental data.

ProtocolCheckpoint(name[, parent])

Class for storing checkpointing intermediate progress during the running of a protocol in order to enable restarting subsequent runs of the protocol from that point.

ProtocolData(edesign[, dataset, cache])

Represents the experimental data needed to run one or more QCVV protocols.

ProtocolPostProcessor(name)

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

ProtocolResults(data, protocol_instance)

Stores the results from running a QCVV protocol on data.

ProtocolResultsDir(data[, protocol_results, ...])

Holds a dictionary of ProtocolResults objects.

ProtocolRunner()

Used to run Protocol objects on an entire tree of data

SimpleRunner(protocol[, ...])

Runs a single protocol on every data node that has no sub-nodes (possibly separately for each pass).

SimultaneousExperimentDesign(edesigns[, ...])

An experiment design whose circuits are the tensor-products of the circuits from one or more sub-designs.

SlurmSettings(script_path[, partition, ...])

Settings for auto-generating a SLURM batch script via Protocol.stage_slurm().

TreeRunner(protocol_dict)

Runs specific protocols on specific data-tree paths.