iqm.qiskit_iqm.iqm_job.IQMJob#

class iqm.qiskit_iqm.iqm_job.IQMJob(backend, job_id, **kwargs)#

Implementation of Qiskit’s job interface to handle circuit execution on an IQM server.

Parameters:

backend (qiskit_iqm.IQMBackend) – the backend instance initiating this job
job_id (str) – string representation of the UUID generated by IQM server
**kwargs – arguments to be passed to the initializer of the parent class

Initializes the asynchronous job.

Parameters:

backend (qiskit_iqm.IQMBackend) – the backend used to run the job.
job_id (str) – a unique id in the context of the backend used to run the job.
kwargs – Any key value metadata to associate with this job.

Attributes

Methods

`_format_iqm_results`(iqm_result)	Convert the measurement results from a batch of circuits into the Qiskit format.
`_format_measurement_results`(...[, ...])	Convert the measurement results from a circuit into the Qiskit format.
`cancel`()	Attempt to cancel the job.
`error_message`()	Returns the error message if job has failed, otherwise returns None.
`queue_position`([refresh])	Return the position of the job in the server queue.
`result`()	Return the results of the job.
`status`()	Return the status of the job, among the values of `JobStatus`.
`submit`()	Submit the job to the backend for execution.

cancel()#

Attempt to cancel the job.

result()#

Return the results of the job.

status()#

Return the status of the job, among the values of JobStatus.

queue_position(refresh=False)#

Return the position of the job in the server queue.

Note

The position is not yet implemented and this function will always return None. The refresh argument is ignored.

Parameters:: refresh (bool) – If True, re-query the server to get the latest value. Otherwise return the cached value.
Returns:: Position in the queue or None if position is unknown or not applicable.
Return type:: int | None

error_message()#

Returns the error message if job has failed, otherwise returns None.

iqm.qiskit_iqm.iqm_job.IQMJob