Skip to main contentIBM Quantum Documentation

Save circuits to disk

Use QPY serialization to save your circuit to file. QPY files store the full Qiskit circuit object and will be compatible with newer versions of Qiskit (although not necessarily with older versions of Qiskit).

To demonstrate, the following cell creates a simple quantum circuit.

[1] :
from qiskit import QuantumCircuit
 
qc = QuantumCircuit(2)
qc.h(0)
qc.cx(0,1)
qc.measure_all()

To save this file to disk, use the qpy.dump function. You can also save a list of circuits.

[2] :
from qiskit import qpy
 
with open('test.qpy', 'wb') as file:
    qpy.dump(qc, file)

This circuit is now saved to the file test.qpy. If you restart your Python kernel, you can re-load the circuit using the qpy.load function. Note that this always returns a list of circuits, even if you only serialized one circuit.

[3] :
with open('test.qpy', 'rb') as handle:
    qc = qpy.load(handle)
 
qc[0].draw('mpl')

Output:

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