Module job

class QuantumInspireJob(api, job_identifier)[source]

Encapsulation of a job.

The QuantumInspireJob class encapsulates the base job of the API and has methods to check the status and retrieve the results from the API.

Parameters:

  • api (QuantumInspireAPI) – An instance to the API.

  • job_identifier (int) – The job identification number.

check_status()[source]

Checks the execution status of the job.

Returns:

The status of the job. Can be: ‘NEW’, ‘RUNNING’, ‘COMPLETE’, ‘CANCELLED’

Return type:

str

retrieve_results()[source]

Gets the results of the job.

Returns:

The execution results with a histogram item containing the result histogram of the job. When an error has occurred the raw_text item shall not be an empty string.

Return type:

Dict[str, Any]

get_job_identifier()[source]

Gets the set job identification number for the wrapped job.

Returns:

The job identification number.

Return type:

int

get_project_identifier()[source]

Gets the project identification number of the wrapped job.

Returns:

The project identification number.

Return type:

int