CancelledException: A result was cancelled

class epyc.CancelledException

An exception stored within the Experiment results dict when a pending result is cancelled without completeing the experiment. This means that all experiments started either complete successfully (and have their results recorded), or fail within the experiment itself (and have that exception stored, without results), or are cancelled (and have this exception and a traceback stored).

ResultSetLockedException: Trying to change a locked result set

class epyc.ResultSetLockedException

An exception raised if an attempt is made to write new results to a result set that’s been locked by a call to ResultSet.finish().

LabNotebookLockedException: Trying to change a locked lab notebook

class epyc.LabNotebookLockedException

An exception raised if an attempt is made to write to a notebook that’s been locked by a call to LabNotebook.finish(). This includes attemoting to add result sets.

PendingResultException: Unrecognised pending result job identifier

class epyc.PendingResultException(jobid: str)

An exception raised if an invalid pending result job identifier is used. A common cause of this is a pending result that failed on submission and so was never actually started.

Parameters:jobid – the job id
PendingResultException.jobid() → str

Return the uinrecopgnised job id.

Returns:the job id

ResultsStructureException: Badly-structured results dict (or dicts)

class epyc.ResultsStructureException(rc: Union[Dict[str, Dict[str, Any]], List[Dict[str, Dict[str, Any]]]])

An exception raised when there is a problem with the structure of a results dict.

Parameters:rc – the results dict structure that causes the problem
ResultsStructureException.resultsdict() → Union[Dict[str, Dict[str, Any]], List[Dict[str, Dict[str, Any]]]]

Return the results dict that caused the problem.

Returns:the results dict or list of them

NotebookVersionException: Unexpected version of a notebook file

class epyc.NotebookVersionException(expected: str, actual: str)

An exception raised when a notebook encounters an unexpected version of a persistent file format.

Parameters:
  • expected – the expected version
  • actual – the actual version
NotebookVersionException.expectedVersion() → str

Return the expected version of the file.

Returns:the expected version
NotebookVersionException.actualVersion() → str

Return the actual version of the file.

Returns:the actual version

DesignException: Impossible design

class epyc.DesignException(msg: str)

An exception raised whenever a set of parameter ranges can’t be used as the basis for a design.