Getting Started¶

Installation¶

To install the MQP Qiskit provider, use the following command:

pip install mqp-qiskit-provider

Overview¶

The Qiskit provider for MQP allows users to access MQP backends through Qiskit. The main components are:

MQPProvider: This is the main entry point for accessing MQP backends.
MQPBackend: It interfaces with the MQP backends.
MQPJob: It handles job submission, cancellation, status checking, and result retrieval.

Usage¶

Import Required Modules¶

Import the necessary components from Qiskit and the MQP provider package.

from qiskit import QuantumCircuit
from mqp.qiskit_provider import MQPProvider

Initialize the MQP Provider¶

Create an instance of MQPProvider by supplying your token from MQP.

provider = MQPProvider(token="<api-token>")

List Available Backends¶

Retrieve and inspect the list of backends accessible to your account.

all_backends = provider.backends()
print("Available backends:", all_backends)

List Online Backends¶

Retrieve and inspect the list of backends that are online and accessible to your account.

all_backends = provider.backends(online=True)
print("Available backends:", all_backends)

Select a Specific Backend¶

Choose a backend by its identifier. Replace <resource-name> with the actual name of the backend.

backend = provider.get_backend("<resource-name>")
# OR
[backend] = provider.backends(name="<resource-name>")

Design Your Quantum Circuit¶

Construct your quantum circuit using Qiskit's QuantumCircuit. For example, create a circuit with 2 qubits and 2 classical bits.

circuit = QuantumCircuit(2, 2)
circuit.h(0)
circuit.cx(0, 1)
circuit.measure([0, 1], [0, 1])

Submit Your Job¶

Submit the circuit for execution on the chosen backend. Specify the number of shots as required. Note that the circuit is transpiled automatically at server before it is submitted to the backend.

job = backend.run(circuit, shots=1000)

Transpile Circuit and Submit Job¶

If you want to transpile the circuit yourself you can do it as follows and then submit it as a job with no_modify=True flag to skip transpilation at server side and submit the circuit as it is to the backend.

The transpilation at user end may not be supported for some backends.

from qiskit import QuantumCircuit, compiler
transpiled_circuit = compiler.transpile(circuit, backend, optimization_level=3)
job = backend.run(transpiled_circuit, shots=1000, no_modify=True)

Checking the Number of Pending Jobs on a Backend¶

To determine if a backend is overloaded, you can check the number of pending jobs using the num_pending_jobs property.

print("Number of pending jobs:", backend.num_pending_jobs)

Queuing a Job when Backend is Offline¶

By default, a job scheduled on a backend with an offline status will be cancelled. To queue a job on an offline backend, use the queued=True flag. This will ensure that the job is enqueued and will be executed once the backend becomes available.

The job is queued for limited time and cancelled if the backend is still offline.

job = backend.run(circuit, shots=1000, queued=True)

Monitor Job Status¶

You can check the status of your job as follows. The status indicates the current stage (e.g., QUEUED, INITIALIZING, DONE).

status = job.status()
print("Job status:", status)

Cancel the Job¶

If necessary, you cancel the job before it completes.

job.cancel()

Retrieve and Display Results¶

Once the job is completed, fetch the results and display the measurement counts.

result = job.result()
counts = result.get_counts()
print("Measurement counts:", counts)

Timestamps for Job Execution¶

result_dict = job.result().to_dict()
print(result_dict["timestamps"]["submitted"])
print(result_dict["timestamps"]["scheduled"])
print(result_dict["timestamps"]["completed"])