Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

QasmQobj

class QasmQobj(qobj_id=None, config=None, experiments=None, header=None)

GitHub(opens in a new tab)

Bases: object

A QASM Qobj.

Instantiate a new QASM Qobj Object.

Each QASM Qobj object is used to represent a single payload that will be passed to a Qiskit provider. It mirrors the Qobj the published Qobj specification(opens in a new tab) for OpenQASM experiments.

Parameters

  • qobj_id (str) – An identifier for the qobj
  • config (QasmQobjRunConfig) – A config for the entire run
  • header (QobjHeader) – A header for the entire run
  • experiments (list) – A list of lists of QasmQobjExperiment objects representing an experiment

Methods

from_dict

classmethod QasmQobj.from_dict(data)

Create a new QASMQobj object from a dictionary.

Parameters

data (dict) – A dictionary representing the QasmQobj to create. It will be in the same format as output by to_dict().

Returns

The QasmQobj from the input dictionary.

Return type

QasmQobj

to_dict

QasmQobj.to_dict()

Return a dictionary format representation of the QASM Qobj.

Note this dict is not in the json wire format expected by IBMQ and qobj specification because complex numbers are still of type complex. Also this may contain native numpy arrays. When serializing this output for use with IBMQ you can leverage a json encoder that converts these as expected. For example:

import json
import numpy
 
class QobjEncoder(json.JSONEncoder):
    def default(self, obj):
        if isinstance(obj, numpy.ndarray):
            return obj.tolist()
        if isinstance(obj, complex):
            return (obj.real, obj.imag)
        return json.JSONEncoder.default(self, obj)
 
json.dumps(qobj.to_dict(), cls=QobjEncoder)

Returns

A dictionary representation of the QasmQobj object

Return type

dict

Was this page helpful?
Report a bug or request content on GitHub.