scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Explain QPY support in install#release-schedule (#1563) 

Qiskit contract with respect of QPY is kind of strong and deserves an
explanation. Adding it to
https://docs.quantum.ibm.com/start/install#release-schedule
This commit is contained in:
Luciano Bello 2024-07-08 16:54:43 +02:00 committed by GitHub
parent 5e2f3f29ee
commit 3299bbdcfe
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/guides/install-qiskit.mdx
View File

@ -327,6 +327,12 @@ ensures that you see any deprecation warnings before a
major version release.
Without the cap, `pip` installs
the newest version available by default.
The QPY serialization format is backwards-compatible so that a new Qiskit release can always load a QPY
file generated with an earlier release of Qiskit. However, the format isn't forward-compatible so, in principle, it's not possible
to load QPY files generated with a newer version of Qiskit using an older release. To facilitate user migration across major version releases, the (`qiskit.qpy.dump()`](/api/qiskit/qpy#dump) function will always support at least one overlapping version between the `X.0.0` and the `X-1.Y.0` release (where `Y` is the last minor version of
that series). The parameter `qiskit.qpy.dump(..., version=...)` will enable saving QPY format files that can be loaded by both major versions from the newer
release. See more details in [RFC 0020](https://github.com/Qiskit/RFCs/blob/master/0020-release_cycle.md#qpy-support).
</details>