Replace qiskit-terra references with qiskit references #1318

wshanks · 2023-11-14T19:23:34Z

This change brings qiskit-experiments in line with other packages like qiskit-ibm-provider and qiskit-aer and prepares for the deprecation of the qiskit-terra package.

Detailed changes:

Replace qiskit-terra dependency with qiskit dependency
- The effective minimum version of qiskit-terra is bumped up one minor version from 0.24 to 0.25 (linked to qiskit 0.44) as part of this change, but since qiskit 0.45 has already been released this should not be an impactful change for most users.
Simplify the code for logging the version of qiskit used. It should always use the Qiskit version as a string. Previously, it could sometimes use a dictionary with the Qiskit and Qiskit Experiments versions.
Remove workaround for aquire_alignment misspelling in old versions of terra (because it was commented referencing terra)
Replace qiskit-terra in requirements-dev.txt and tox.ini
Replace various references to "terra" in various code comments with "Qiskit"
Rename terra-main and docs-terra-main tox environments to qiskit-main and docs-qiskit-main
Rename GitHub workflow job terra-main-tests to qiskit-main-tests

The only remaining references to "terra" in the codebase are in old release notes.

This change brings qiskit-experiments in line with other packages like qiskit-ibm-provider and qiskit-aer and prepares for the deprecation of the qiskit-terra package. The effective minimum version of qiskit-terra is bumped up one minor version from 0.24 to 0.25 (linked to qiskit 0.44) as part of this change, but since qiskit 0.45 has already been released this should not be an impactful change for most users.

wshanks · 2023-11-14T19:47:02Z

One question is whether to add a <1.0 bound to the qiskit version. I think this may depend on when we think the next experiments release will happen relative to the qiskit 1.0 feature freeze (some time in January). I think most of the major changes to qiskit before 1.0 should happen in the next couple weeks, so if we release after that it might be better to leave the bound off so that users don't have to choose between qiskit 1.0 and experiments. On the other hand, if we think something is likely to break, we could put <1.0 and plan to make a patch release in January to remove the bound when qiskit 1.0.0rc1 comes out, so that there is an experiments version available that his compatible with 1.0.

coruscating · 2023-11-14T21:28:36Z

requirements_dev.txt also has qiskit-terra as a requirement. Perhaps we should also replace various references to terra throughout the codebase, like the tox envs and qiskit_version().

wshanks · 2023-11-14T21:40:28Z

Good point. I was mainly thinking about reporting a dependence on qiskit for installing cleanly into a qiskit environment. I will do a wider search of "terra" usage in the repo.

wshanks · 2023-11-15T19:59:38Z

@coruscating I removed more terra usage (see edited PR description). The remaining terra references in the repo are in old release notes.

The most disruptive changes are renaming the tox environments and the GitHub workflow job for testing again Qiskit main, but I don't think we should stick with the old names to avoid disruption since they will become confusing as the memory of terra fades.

coruscating

Thanks, this is good overall and I agree with keeping older mentions of Terra in the release notes.

coruscating · 2023-11-15T21:49:36Z

qiskit_experiments/database_service/utils.py

-        return pkg_resources.get_distribution("qiskit").version
-    except Exception:  # pylint: disable=broad-except
-        return {"qiskit-terra": terra_version, "qiskit-experiments": experiments_version}
+    return importlib.metadata.distribution("qiskit").version


Should this not also return the Qiskit Experiments version like the previous code did in the except clause? I'm not quite sure what this function is meant for.

I was a little confused by this part. Qiskit is a required dependency, so we should be able to get its version without error and not need the except block, so I went with what the try block was doing to continue the existing behavior. I pushed a new commit to switch to the except block style of capturing qiskit and qiskit-experiments. I thought about capturing other packages (qiskit-ibm-experiment?) but I think these two make the most sense. qiskit changes could change transpilation and affect the circuits in something like RB. qiskit-experiments could change the circuits method or the analysis function. So it is good to capture both with the experiment metadata.

Thanks, saving both makes sense and we probably should have been doing that earlier. We may have to change this to git commit IDs in the future but this is good for now.

That's a good idea. I had been thinking about that. I have done it on other repos before.

coruscating · 2023-11-15T22:17:12Z

releasenotes/notes/qiskit-dependency-3f6b8d71cc4d2c31.yaml

+upgrade:
+  - |
+    The dependency on ``qiskit-terra`` was replaced with a dependency on
+    ``qiskit``. This change follows the move in upstream Qiskit to rename


Should the old and new version numbers be explicitly mentioned here too?

Done but we need to keep this release note in mind if we merge #1288 and increase the minimum qiskit version.

wshanks · 2023-11-16T04:25:51Z

@coruscating Besides addressing your comments, I added an upper bound on the qiskit version like you had suggested outside of the PR.

coruscating

LGTM, thanks!

wshanks · 2023-11-16T14:22:39Z

I added the Changelog: API Change label. It's not really an API change but my understanding is that this will make it show up in the "Changed" section of the release notes which is the best fit. I wonder if we want an "Other" or "Upgrade note" category.

coruscating · 2023-11-16T15:00:37Z

@wshanks I've just been redirecting users to the release notes in the github releases section since I haven't been careful with changelog labels (for example, a lot of backlogged PRs aren't correctly labeled since labels on the original PR don't get carried over to the automatic mergify PRs). We should revisit our changelog policy and decide what to do about them going forward.

…ity#1318) This change brings qiskit-experiments in line with other packages like qiskit-ibm-provider and qiskit-aer and prepares for the deprecation of the qiskit-terra package. Detailed changes: * Replace qiskit-terra dependency with qiskit dependency - The effective minimum version of qiskit-terra is bumped up one minor version from 0.24 to 0.25 (linked to qiskit 0.44) as part of this change, but since qiskit 0.45 has already been released this should not be an impactful change for most users. * Simplify the code for logging the version of qiskit used. It should always use the Qiskit version as a string. Previously, it could sometimes use a dictionary with the Qiskit and Qiskit Experiments versions. * Remove workaround for `aquire_alignment` misspelling in old versions of terra (because it was commented referencing terra) * Replace qiskit-terra in requirements-dev.txt and tox.ini * Replace various references to "terra" in various code comments with "Qiskit" * Rename terra-main and docs-terra-main tox environments to qiskit-main and docs-qiskit-main * Rename GitHub workflow job terra-main-tests to qiskit-main-tests The only remaining references to "terra" in the codebase are in old release notes.

wshanks added 4 commits November 15, 2023 14:34

Replace package/repo references to qiskit-terra with qiskit

4cd7b50

Remove workarounds for aquire_alignment misspelling

7a877ff

Simplify logging of qiskit version

d77779a

Remove stray references to terra

12cc337

wshanks changed the title ~~Replace qiskit-terra dependency with qiskit dependency~~ Replace qiskit-terra references with qiskit references Nov 15, 2023

wshanks added 2 commits November 15, 2023 14:54

Remove unused imports

e0a17a2

Replace terra usage in tox.ini and GitHub workflows

35a8da8

Typo

f94166a

coruscating reviewed Nov 15, 2023

View reviewed changes

wshanks added the Changelog: None Do not include in changelog label Nov 16, 2023

wshanks added 3 commits November 15, 2023 23:16

Log both qiskit and qiskit-experiments versions

bc4dd22

Report the minimum required qiskit version in the release note

e42b0be

Limit qiskit version to <1.0

6460bb6

coruscating approved these changes Nov 16, 2023

View reviewed changes

wshanks added this pull request to the merge queue Nov 16, 2023

wshanks added Changelog: API Change Include in the "Changed" section of the changelog and removed Changelog: None Do not include in changelog labels Nov 16, 2023

Merged via the queue into qiskit-community:main with commit 8f87c20 Nov 16, 2023
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace qiskit-terra references with qiskit references #1318

Replace qiskit-terra references with qiskit references #1318

wshanks commented Nov 14, 2023 •

edited

Loading

wshanks commented Nov 14, 2023

coruscating commented Nov 14, 2023

wshanks commented Nov 14, 2023

wshanks commented Nov 15, 2023

coruscating left a comment

coruscating Nov 15, 2023

wshanks Nov 16, 2023

coruscating Nov 16, 2023

wshanks Nov 16, 2023

coruscating Nov 15, 2023

wshanks Nov 16, 2023

wshanks commented Nov 16, 2023

coruscating left a comment

wshanks commented Nov 16, 2023

coruscating commented Nov 16, 2023

Replace qiskit-terra references with qiskit references #1318

Replace qiskit-terra references with qiskit references #1318

Conversation

wshanks commented Nov 14, 2023 • edited Loading

wshanks commented Nov 14, 2023

coruscating commented Nov 14, 2023

wshanks commented Nov 14, 2023

wshanks commented Nov 15, 2023

coruscating left a comment

Choose a reason for hiding this comment

coruscating Nov 15, 2023

Choose a reason for hiding this comment

wshanks Nov 16, 2023

Choose a reason for hiding this comment

coruscating Nov 16, 2023

Choose a reason for hiding this comment

wshanks Nov 16, 2023

Choose a reason for hiding this comment

coruscating Nov 15, 2023

Choose a reason for hiding this comment

wshanks Nov 16, 2023

Choose a reason for hiding this comment

wshanks commented Nov 16, 2023

coruscating left a comment

Choose a reason for hiding this comment

wshanks commented Nov 16, 2023

coruscating commented Nov 16, 2023

wshanks commented Nov 14, 2023 •

edited

Loading