Skip to content
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.

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

Document external simulators. #2811

Merged
merged 2 commits into from
Mar 6, 2020

Conversation

95-martin-orion
Copy link
Collaborator

Added notes on qsim[h] and qFlex, with links to their respective repositories.

Notably, neither of these currently support SimulatesSamples, although it wouldn't be too costly to distill samples from the results of a qsim full-state simulation.

@googlebot googlebot added the cla: yes Makes googlebot stop complaining. label Mar 5, 2020
Copy link
Collaborator

@viathor viathor left a comment

Choose a reason for hiding this comment

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

qflexcirq appears missing on PyPI.

| --- | --- | --- |
| [qsim](https://github.com/quantumlib/qsim) | qsimcirq | Implements `SimulatesAmplitudes` and `SimulatesFinalState`. Recommended for deep circuits with up to 30 qubits (consumes 8GB RAM). Larger circuits are possible, but RAM usage doubles with each additional qubit. |
| [qsimh](https://github.com/quantumlib/qsim/blob/master/qsimcirq/qsimh_simulator.py) | qsimcirq | Implements `SimulatesAmplitudes`. Intended for heavy parallelization across several computers; Cirq users should generally prefer one of the other simulators listed here. |
| [qFlex](https://github.com/ngnrsaa/qflex) | qflexcirq | Implements `SimulatesAmplitudes`. Recommended for shallow / low-entanglement circuits with more than 30 qubits. RAM usage is highly dependent on the number of two-qubit gates in the circuit. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've checked in with the team - they're currently working to get it online. Once that link resolves I'll go ahead with the merge.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That link is now happy - pip3 install qflexcirq should work as expected.

Copy link
Collaborator

@viathor viathor left a comment

Choose a reason for hiding this comment

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

Thanks!

@95-martin-orion 95-martin-orion merged commit 4127397 into quantumlib:master Mar 6, 2020
@95-martin-orion 95-martin-orion deleted the sim-docs branch March 6, 2020 17:51
95-martin-orion added a commit that referenced this pull request Jun 24, 2020
This copies changes from #2811 into the Jupyter notebook.
CirqBot pushed a commit that referenced this pull request Jun 24, 2020
This copies changes from #2811 into the Jupyter notebook.
tai271828 pushed a commit to tai271828/Cirq that referenced this pull request Jun 26, 2020
This copies changes from quantumlib#2811 into the Jupyter notebook.
tai271828 pushed a commit to tai271828/Cirq that referenced this pull request Jun 27, 2020
This copies changes from quantumlib#2811 into the Jupyter notebook.
tonybruguier pushed a commit to tonybruguier/Cirq that referenced this pull request Aug 23, 2020
This copies changes from quantumlib#2811 into the Jupyter notebook.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Makes googlebot stop complaining.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants