Remove sympy as a hard dependency #14396
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mtreinish
added
the
Changelog: API Change
|
One or more of the following people are relevant to this code:
|
|
Oh looks like a few tests are missing skip decorators so the tests without optionals installed are failing. |
Pull Request Test Coverage Report for Build 15395252099Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
mtreinish
force-pushed
the
remove-sympy-for-good-mostly
branch
from
c72288c to
1544896
Compare
With the move to symbolic expression class added in Qiskit#13278 the dependency on sympy is no longer as core to the Qiskit package as it was in the past. The only pieces that are still reliant on it are QPY deserialization of payloads older than QPY v13 and some small visualization utilities where sympy is used to generate the output. Since this functionality is not core to the library and only used in some less common use cases we no longer need to install sympy for every installation of Qiskit. In preparation for this Qiskit 2.0 laid the groundwork by marking all uses of sympy in Qiskit as being fallible if sympy was not installed and documented that sympy is not guaranteed to be installed with Qiskit anymore. This commit implements this change and moves sympy to be an optional dependency only used by some small components.
mtreinish
force-pushed
the
remove-sympy-for-good-mostly
branch
from
1544896 to
fc437ea
Compare
Cryoris
reviewed
May 27, 2025
Cryoris
reviewed
May 27, 2025
Cryoris
reviewed
Jun 2, 2025
Co-authored-by: Julien Gacon <[email protected]>
Cryoris
approved these changes
Jun 2, 2025
rahaman-quantum
pushed a commit
to rahaman-quantum/qiskit
that referenced
this pull request
Jun 20, 2025
* Remove sympy as a hard dependency With the move to symbolic expression class added in Qiskit#13278 the dependency on sympy is no longer as core to the Qiskit package as it was in the past. The only pieces that are still reliant on it are QPY deserialization of payloads older than QPY v13 and some small visualization utilities where sympy is used to generate the output. Since this functionality is not core to the library and only used in some less common use cases we no longer need to install sympy for every installation of Qiskit. In preparation for this Qiskit 2.0 laid the groundwork by marking all uses of sympy in Qiskit as being fallible if sympy was not installed and documented that sympy is not guaranteed to be installed with Qiskit anymore. This commit implements this change and moves sympy to be an optional dependency only used by some small components. * Add sympy to backwards compat qpy jobs * Update release notes * Update releasenotes/notes/no-sympy-19687d5ca814042c.yaml Co-authored-by: Julien Gacon <[email protected]> --------- Co-authored-by: Julien Gacon <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
With the move to symbolic expression class added in #13278 the
dependency on sympy is no longer as core to the Qiskit package as it was
in the past. The only pieces that are still reliant on it are QPY
deserialization of payloads older than QPY v13 and some small
visualization utilities where sympy is used to generate the output.
Since this functionality is not core to the library and only used in
some less common use cases we no longer need to install sympy for every
installation of Qiskit. In preparation for this Qiskit 2.0 laid the
groundwork by marking all uses of sympy in Qiskit as being fallible if
sympy was not installed and documented that sympy is not guaranteed to
be installed with Qiskit anymore.
This commit implements this change and moves sympy to be an optional
dependency only used by some small components.
Details and comments
This is based on #14389 and #14391 and will need to be rebased after those PRs merge, Until that is done you can view the contents of just this PR with the head commit: c72288cNow that both dependencies have merged this has been rebased.