Skip to content

Document NumPy 1 interaction with max simulation size #1015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kris524 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

Document NumPy 1 interaction with max simulation size #1015

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/choose_hw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,13 @@ depth beyond 20 qubits.
* The total small circuits runtime overhead for an N qubit circuit
depends on the circuit depth and on N. The overhead can be large enough to
conceal the $2^N$ growth in runtime.
* NumPy version matters for large simulations:
* Some users have reported being unable to simulate circuits with more than
~32 qubits when using NumPy 1.26.
* Updating NumPy to version 2.x resolved the issue in these cases.
* If you encounter unexpected failures, memory errors, or hard limits on
the number of qubits, ensure you are running a recent NumPy version
before further debugging.
Comment on lines +314 to +320
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

This documentation change introduces an inconsistency with the project's dependencies. While it correctly warns about issues with NumPy 1.26 for large simulations, requirements.txt still specifies numpy>=1.26.0. This can lead to users installing a version known to have problems for certain use cases, creating a frustrating experience.

To maintain consistency within the project, please update requirements.txt to align with this new recommendation. For example, you could change the dependency to numpy>=2.0. If this is not feasible, the documentation should explain the trade-offs.

References
  1. The repository style guide emphasizes consistency across the codebase. The documented NumPy recommendation conflicts with the version specified in requirements.txt, creating an inconsistency. (link)


## Sample benchmarks

Expand Down
Loading