pygsti.tools.exceptions

pygsti.tools.exceptions#

Defines GST exception classes

Exceptions

CVXPYFailure

Numerical solvers dispatched by CVXPY failed when trying to solve a pyGSTi-constructed problem.

ClobberingWarning

Inform the user that contradictory values have been encountered in some operation, and that we'll adopt some heuristic for choosing one of the values.

DeprecatedPositionalArgumentsWarning

Inform the user that they're using positional arguments that should be specified as keyword arguments.

DubiousTargetWarning

Alert the user that a target specification is somehow unusual and may not be what they intended.

ForwardSimDiagnosticWarning

Inner-loop numerical-scaling diagnostic from the forward simulator (e.g., 'Scaled dProd small to keep prod manageable', 'hProd is small').

GSTRuntimeError

Gate Set Tomography run-time exception class.

GSTValueError

Gate Set Tomography value error exception class.

ImplicitlyDoneEditingCircuitWarning

Inform the user that a Circuit.__hash__ has been called on a Circuit with Circuit.editable == True.

MissingDependencyWarning

Inform the user that we're missing an optional dependency they PROBABLY want, but isn't strictly required.

NumericalDomainWarning

Inform the user that some mathematical function is being applied on an input that's slightly outside of its usual domain.

OverparameterizationWarning

Signal that the maximal model has fewer parameters than the current model.

PrepareThyself

Indicate to the user that there's good reason to expect that what they're about to do will fail.

ProbabilityClippingWarning

A simulated outcome probability fell outside [0, 1] (or a set of outcome probabilities did not sum to 1) by more than the configured tolerance, and was clipped/renormalized.

QiskitInteropWarning

Inform the user about a qiskit-interoperability issue: a qiskit version mismatch against the version pyGSTi was developed/tested against, or a lossy round-trip (e.g., pyGSTi circuit mapping that does not preserve qreg structure or classical registers), or a qiskit-specific argument that's being ignored.

StolenResourceWarning

Suppose we have two types with a parent-child relationship, Foo and Bar.

UnknownGaugeSpaceDimension

Inform the user that we weren't sure of the dimension of gauge space in current model parameterization.

UnnamedReportWarning

Signal that we're generating a name for a report automatically and randomly, since a user didn't provide a name.

UntouchedModelNoiseKey

Alert the user that they may have incorrectly constructed an OpModelNoise object.

pyGSTiDeprecationWarning

A helper class so users (and pyGSTi developers) can distinguish between deprecation warnings raised by us versus by other libraries.