Replace `qiskit` metapackage with `qiskit-terra` #11271

jakelishman · 2023-11-17T21:28:16Z

Summary

This commit completely removes the concept of the qiskit-terra package from Qiskit main. The hitherto metapackage qiskit is promoted to be the concrete code package.

This is a completely breaking change for packaging purposes for users, as there is no clean upgrade path from qiskit-terra to qiskit; PyPI and pip do not give us the tools to mark that the former obsoletes and supersedes the latter. We intend to follow this PR with a technical blog post somewhere explaining the changes, how users should adapt ("to install Qiskit 1.0, you must start a new venv"), and why we needed to do this.

The "why", in part, is:

the metapackage legacy causes awkward upgrade paths on every release; some packages still depend on qiskit-terra, some on qiskit, and pip will happily make those two get out-of-sync when upgrading a transitive dependency with only a warning that users are used to ignoring.
with the 1.0 release, we (believe we) will have some leeway from users to make such a breaking change.
having the metapackage split makes it difficult for downstream projects and developers to test against main - they always must install both qiskit-terra and qiskit, and the latter has no meaning in editable installs, so needs re-installing after each version bump. Problems surrounding this have already broken CI for Qiskit, for at least one internal IBM repo, and at least my dev install of Qiskit. This could be improved a bit with more education, but it's still always going to increase the barrier to entry and make it much harder to do the right thing.

We will not publish any 1.0 or above version of qiskit-terra. All dependents on Qiskit should switch their requirements to qiskit.

Details and comments

We will be accompanying this change with a blog post with more information, and issuing warnings from Qiskit 0.46 about the upcoming change as well.

qiskit-bot · 2023-11-17T21:28:21Z

One or more of the the following people are requested to review this:

@Qiskit/terra-core

coveralls · 2023-11-17T21:51:13Z

Pull Request Test Coverage Report for Build 7009157389

0 of 0 changed or added relevant lines in 0 files are covered.
21 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-0.02%) to 87.068%

Files with Coverage Reduction	New Missed Lines	%
crates/qasm2/src/lex.rs	3	92.68%
crates/qasm2/src/parse.rs	18	96.67%

Totals
Change from base Build 7004497279:	-0.02%
Covered Lines:	60801
Relevant Lines:	69832

💛 - Coveralls

jakelishman · 2023-11-17T22:44:35Z

Ah, this cannot succeed until we can use Aer 0.13, because Aer 0.12.2 still has an old dependency on qiskit-terra, which means we're on hold pending Qiskit/qiskit-aer#1983 for now.

This commit completely removes the concept of the `qiskit-terra` package from Qiskit main. The hitherto metapackage `qiskit` is promoted to be the concrete code package. This is a completely breaking change for packaging purposes for users, as there is no clean upgrade path from `qiskit-terra` to `qiskit`; PyPI and pip do not give us the tools to mark that the former obsoletes and supersedes the latter. We intend to follow this PR with a technical blog post somewhere explaining the changes, how users should adapt ("to install Qiskit 1.0, you must start a new venv"), and why we needed to do this. The "why", in part, is: - the metapackage legacy causes awkward upgrade paths on every release; some packages still depend on `qiskit-terra`, some on `qiskit`, and pip will happily make those two get out-of-sync when upgrading a transitive dependency with only a warning that users are used to ignoring. - with the 1.0 release, we (believe we) will have some leeway from users to make such a breaking change. - having the metapackage split makes it difficult for downstream projects and developers to test against `main` - they always must install both `qiskit-terra` and `qiskit`, and the latter has no meaning in editable installs, so needs re-installing after each version bump. Problems surrounding this have already broken CI for Qiskit, for at least one internal IBM repo, and at least my dev install of Qiskit. This could be improved a bit with more education, but it's still always going to increase the barrier to entry and make it much harder to do the right thing. We will not publish any 1.0 or above version of `qiskit-terra`. All dependents on Qiskit should switch their requirements to `qiskit`.

jakelishman · 2023-11-24T20:17:21Z

Relevant fix to Neko is Qiskit/qiskit-neko#36.

mtreinish

Overall this LGTM, one tiny nit in the docs about the windows usage of venv,

mtreinish · 2023-11-27T18:03:07Z

releasenotes/notes/terra-nullius-7ef598626d8118c1.yaml

+ # Install Qiskit (only once).
+ pip install 'qiskit>=1.0'
+
+ On Windows, replace ``source <venv>/bin/activate`` with ``source <venv>/Scripts/activate``.


Suggested change

On Windows, replace ``source <venv>/bin/activate`` with ``source <venv>/Scripts/activate``.

On Windows, replace ``source <venv>/bin/activate`` with ``source <venv>\Scripts\activate``.

Although I guess it really depends on which windows shell you're using it'd be <venv>\Scripts\activate.bat if you're using cmd.exe or PS <venv>\Scripts\Activate.ps1 if you're using powershell. This would work if you're using bash on windows I guess though.

This is true, I forgot people used things other than bash-likes. Shall we do something more here? I'm not sure what to write without going too overboard - I don't really know how most Windows users interact with venv.

When I'm debugging something on windows personally I either do it via git bash (so what you had would work) or via cmd.exe and call the activate.bat file. It often depends on what I'm debugging as either shell might be needed to reproduce an issue if it involves output or default character encoding.

But it might be better to refer to the stdlib python docs here https://docs.python.org/3/library/venv.html#how-venvs-work

That's a good idea - done in 6f5b066.

Co-authored-by: Matthew Treinish <[email protected]>

mtreinish

LGTM, thanks for the quick update.

See Qiskit/qiskit#11271.

### Summary Now that the metapackage has been removed in Qiskit/qiskit#11271, we should be able to run the daily cron jobs against `qiskit` and not `qiskit-terra`.

In Qiskit#11119 we removed the use_develop flag in the tox config which was used to tell tox to use a single editable install for running a job (avoiding the need to build from sdist on every run) as part of a temporary refactoring to ensure we installed the metapackage along with terra. Now that we've standardized the packaging in Qiskit#11271 that was undone, but the usedevelop flag was not added back. This has caused tox to rebuild the package from sdist on every run even if there are no code changes. This commit restores the missing option to fix this.

…ns#1329) ### Summary Now that the metapackage has been removed in Qiskit/qiskit#11271, we should be able to run the daily cron jobs against `qiskit` and not `qiskit-terra`.

* Unwrap the `Tensor` objects from Qiskit Nature as necessary Fixes #406 * Revert "Temporarily remove Qiskit Nature from dev version tests (#407)" This reverts commit 88e2195. * `unfold` the `S8Integrals` * Install qiskit only, not qiskit-terra See Qiskit/qiskit#11271. * Unpin qiskit-nature We'll probably also need to bump the version to 0.7 or higher, but let's do that once the code is ready. * Update forging to support Qiskit 1.0 and Nature 0.7 * Remove serverless tutorials * Update ruff config * Ignore forging tutorial 1 * Update qiskit readme shield. Update dev version of Qiskit to point to main branch * Move ruff changes out of this PR * Remove 0.46 from dev version testing * Update path to qiskit TwoQubitWeylDecomposition * Use 0.46 targets until 1.0 is released. * Get all tests passing by removing problematic test modules * ruff * Bump rustwork version to be compatible w Qiskit 1.0 * Bump dev version to 1.0 from 0.46 * Bug in dev workflow * Remove do_while from PassManager used to remove resets * Fix notebooks * Put do_while back * Fix recursion error with forging * Dont ignore forging tutorial * Install Nature from pypi * Make compatible with 0.46+1.0 * .github/workflows/test_development_versions.yml * Bug in cutting_experiments * Use DoWhileController * Fix impmort of DWController * Bump min qiskit version * bump max vers --------- Co-authored-by: Jim Garrison <[email protected]> Co-authored-by: Jim Garrison <[email protected]>

jakelishman added type: qa Issues and PRs that relate to testing and code quality Changelog: API Change Include in the "Changed" section of the changelog labels Nov 17, 2023

jakelishman added this to the 1.0.0pre1 milestone Nov 17, 2023

jakelishman requested a review from a team as a code owner November 17, 2023 21:28

jakelishman changed the title ~~Replace qiskit metapacakge with qiskit-terra~~ Replace qiskit metapackage with qiskit-terra Nov 17, 2023

jakelishman force-pushed the terra-nullius branch from 0a99562 to 86c9ec7 Compare November 17, 2023 21:31

mtreinish added the priority: high label Nov 17, 2023

jakelishman added the on hold Can not fix yet label Nov 17, 2023

jakelishman force-pushed the terra-nullius branch from 86c9ec7 to 541143e Compare November 24, 2023 20:03

jakelishman removed the on hold Can not fix yet label Nov 24, 2023

jakelishman force-pushed the terra-nullius branch from 541143e to 2feb8f9 Compare November 24, 2023 20:04

jakelishman added 2 commits November 24, 2023 21:27

Add manual uninstall for Neko

2e986d7

Merge remote-tracking branch 'ibm/main' into terra-nullius

560c47a

mtreinish reviewed Nov 27, 2023

View reviewed changes

jakelishman and others added 2 commits November 27, 2023 18:05

Fix Windows paths

d8b7ebf

Co-authored-by: Matthew Treinish <[email protected]>

Refer to stdlib documentation for odd shells

6f5b066

mtreinish approved these changes Nov 27, 2023

View reviewed changes

mtreinish enabled auto-merge November 27, 2023 18:23

auto-merge was automatically disabled November 27, 2023 20:17
Pull Request is not mergeable

jakelishman added this pull request to the merge queue Nov 27, 2023

Merged via the queue into Qiskit:main with commit e91947e Nov 27, 2023
14 checks passed

jakelishman deleted the terra-nullius branch November 27, 2023 22:22

garrison added a commit to Qiskit-Extensions/circuit-knitting-toolbox that referenced this pull request Nov 28, 2023

Install qiskit only, not qiskit-terra

5dfd647

See Qiskit/qiskit#11271.

jakelishman mentioned this pull request Nov 28, 2023

Prepare 0.45.1 release #11331

Merged

1 task

coruscating mentioned this pull request Nov 28, 2023

Replace qiskit-terra dev requirement with qiskit Qiskit-Extensions/qiskit-experiments#1329

Merged

mtreinish mentioned this pull request Nov 30, 2023

Rename qiskit-terra into qiskit and remove the metapackage #11240

Closed

mtreinish mentioned this pull request Dec 7, 2023

Add missing use_develop to tox.ini #11380

Open

kikomiss mentioned this pull request Jan 19, 2024

Add support for Qiskit v1.0 qiskit-community/qiskit-ionq#161

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace `qiskit` metapackage with `qiskit-terra` #11271

Replace `qiskit` metapackage with `qiskit-terra` #11271

jakelishman commented Nov 17, 2023

qiskit-bot commented Nov 17, 2023

coveralls commented Nov 17, 2023 •

edited

Loading

jakelishman commented Nov 17, 2023 •

edited

Loading

jakelishman commented Nov 24, 2023

mtreinish left a comment

mtreinish Nov 27, 2023

jakelishman Nov 27, 2023

mtreinish Nov 27, 2023

mtreinish Nov 27, 2023

jakelishman Nov 27, 2023

mtreinish left a comment

	On Windows, replace ``source <venv>/bin/activate`` with ``source <venv>/Scripts/activate``.
	On Windows, replace ``source <venv>/bin/activate`` with ``source <venv>\Scripts\activate``.

Replace qiskit metapackage with qiskit-terra #11271

Replace qiskit metapackage with qiskit-terra #11271

Conversation

jakelishman commented Nov 17, 2023

Summary

Details and comments

qiskit-bot commented Nov 17, 2023

coveralls commented Nov 17, 2023 • edited Loading

Pull Request Test Coverage Report for Build 7009157389

💛 - Coveralls

jakelishman commented Nov 17, 2023 • edited Loading

jakelishman commented Nov 24, 2023

mtreinish left a comment

Choose a reason for hiding this comment

mtreinish Nov 27, 2023

Choose a reason for hiding this comment

jakelishman Nov 27, 2023

Choose a reason for hiding this comment

mtreinish Nov 27, 2023

Choose a reason for hiding this comment

mtreinish Nov 27, 2023

Choose a reason for hiding this comment

jakelishman Nov 27, 2023

Choose a reason for hiding this comment

mtreinish left a comment

Choose a reason for hiding this comment

Replace `qiskit` metapackage with `qiskit-terra` #11271

Replace `qiskit` metapackage with `qiskit-terra` #11271

coveralls commented Nov 17, 2023 •

edited

Loading

jakelishman commented Nov 17, 2023 •

edited

Loading