@@ -41,6 +41,30 @@ cloning the repository:
41
41
The ``-e `` option will keep your installed package up to date as you make or pull new
42
42
changes.
43
43
44
+ Upgrading Qiskit Experiments
45
+ ----------------------------
46
+
47
+ Qiskit Experiments version numbers are in the form ``0.X.Y ``, where ``X `` is the minor version and
48
+ ``Y `` is the patch version. There are two kinds of releases: minor releases, which increment the
49
+ minor version, and patch releases, which increment the patch version. New features and API
50
+ changes can only be introduced in a minor release. Patch releases contain only bug fixes and changes that do
51
+ not affect how you use the package, such as performance optimization and documentation updates.
52
+
53
+ Therefore, when you encounter a bug or unexpected behavior, it is recommended that you first check if there's a
54
+ patch release you can upgrade to under the same minor version to avoid any breaking changes. When
55
+ running ``pip ``, you can specify the exact version to install:
56
+
57
+ .. code-block ::
58
+
59
+ python -m pip install qiskit-experiments==0.X.Y
60
+
61
+ Before a nontrivial breaking API change is introduced in a minor release, the old feature will
62
+ undergo a deprecation process lasting two releases for a core framework change and one release
63
+ otherwise. During this process, deprecation warnings will be issued if you use the old feature that
64
+ will instruct you on how to transition to the replacement feature, if applicable. The :doc: `release
65
+ notes </release_notes>` contain full details on which features are deprecated or removed in each
66
+ release.
67
+
44
68
Running your first experiment
45
69
=============================
46
70
@@ -73,11 +97,6 @@ All experiments require a ``physical_qubits`` parameter as input that specifies
73
97
physical qubit or qubits the circuits will be executed on. The qubits must be given as a
74
98
Python sequence (usually a tuple or a list).
75
99
76
- .. note ::
77
- Since 0.5.0, using ``qubits `` instead of ``physical_qubits `` or specifying an
78
- integer qubit index instead of a one-element sequence for a single-qubit experiment
79
- is deprecated.
80
-
81
100
In addition, the :math: `T_1 ` experiment has
82
101
a second required parameter, ``delays ``, which is a list of times in seconds at which to
83
102
measure the excited state population. In this example, we'll run the :math: `T_1 `
0 commit comments