Skip to content

Commit

Permalink
Add QPY format version table to the docs (Qiskit#12284)
Browse files Browse the repository at this point in the history
* Add QPY format version table to the docs

This commit adds a new table to the QPY module docs that outlines all
the supported QPY format versions for every qiskit/qiskit-terra release
that had qpy. This information is potentially useful when trying to
navigate generating QPY files across versions.

Fixes Qiskit#12283

* Update qiskit/qpy/__init__.py
  • Loading branch information
mtreinish authored Apr 26, 2024
1 parent 80b54b9 commit 1802732
Showing 1 changed file with 129 additions and 0 deletions.
129 changes: 129 additions & 0 deletions qiskit/qpy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,135 @@
.. autoexception:: QPYLoadingDeprecatedFeatureWarning
QPY format version history
--------------------------
If you're planning to load a QPY file between different Qiskit versions knowing
which versions were available in a given release are useful. As the QPY is
backwards compatible but not forwards compatible you need to ensure a given
QPY format version was released in the release you're calling :func:`.load`
with. The following table lists the QPY versions that were supported in every
Qiskit (and qiskit-terra prior to Qiskit 1.0.0) release going back to the introduction
of QPY in qiskit-terra 0.18.0.
.. list-table: QPY Format Version History
:header-rows: 1
* - Qiskit (qiskit-terra for < 1.0.0) version
- :func:`.dump` format(s) output versions
- :func:`.load` maximum supported version (older format versions can always be read)
* - 1.1.0
- 10, 11, 12
- 12
* - 1.0.2
- 10, 11
- 12
* - 1.0.1
- 10, 11
- 11
* - 1.0.0
- 10, 11
- 11
* - 0.46.1
- 10
- 10
* - 0.45.3
- 10
- 10
* - 0.45.2
- 10
- 10
* - 0.45.1
- 10
- 10
* - 0.45.0
- 10
- 10
* - 0.25.3
- 9
- 9
* - 0.25.2
- 9
- 9
* - 0.25.1
- 9
- 9
* - 0.24.2
- 8
- 8
* - 0.24.1
- 7
- 7
* - 0.24.0
- 7
- 7
* - 0.23.3
- 6
- 6
* - 0.23.2
- 6
- 6
* - 0.23.1
- 6
- 6
* - 0.23.0
- 6
- 6
* - 0.22.4
- 5
- 5
* - 0.22.3
- 5
- 5
* - 0.22.2
- 5
- 5
* - 0.22.1
- 5
- 5
* - 0.22.0
- 5
- 5
* - 0.21.2
- 5
- 5
* - 0.21.1
- 5
- 5
* - 0.21.0
- 5
- 5
* - 0.20.2
- 4
- 4
* - 0.20.1
- 4
- 4
* - 0.20.0
- 4
- 4
* - 0.19.2
- 4
- 4
* - 0.19.1
- 3
- 3
* - 0.19.0
- 2
- 2
* - 0.18.3
- 1
- 1
* - 0.18.2
- 1
- 1
* - 0.18.1
- 1
- 1
* - 0.18.0
- 1
- 1
.. _qpy_format:
**********
Expand Down

0 comments on commit 1802732

Please sign in to comment.