Fix #1137 and #908: replace README.rst with Markdown version & update content #1143
+246
−223
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
This replaces the reStructuredText version of the README file with a Markdown version, for better compatibility with our practices in our other repos. In addition, it removes the OpenFermion logo to follow the updated branding guidelines for Quantum AI. It also slightly reorganizes the content, provides a BibTeX version of the citation info, and adds the standard Google disclaimer and our QAI logo at the bottom.
This adds the same QAI logo image used in our other repos.
mhucka
changed the title
mhucka
changed the title
mhucka
added
the
area/docs
pavoljuhas
reviewed
Oct 3, 2025
| the electronic structure plugins are only compatible on these platforms. However, for those who | ||
| would like to use Windows, or for anyone having other difficulties with installing OpenFermion or | ||
| its plugins, we provide instructions for creating and using a Docker image – see the | ||
| [`docker/`](https://github.com/quantumlib/OpenFermion/tree/master/docker) subdirectory. The Docker |
There was a problem hiding this comment.
Please replace master --> main here and in other links below.
pavoljuhas
reviewed
Oct 3, 2025
| [](https://pypi.org/project/OpenFermion) | ||
| [](https://img.shields.io/pypi/dm/OpenFermion) | ||
|
|
||
| [Features](#features) – |
There was a problem hiding this comment.
Nit - would the unicode ndash character – work here as well?
pavoljuhas
reviewed
Oct 3, 2025
|
|
||
| ## Citing OpenFermion<a name="how-to-cite-openfermion"></a><a name="how-to-cite"></a> | ||
|
|
||
| When using OpenFermion for research projects, please cite: |
There was a problem hiding this comment.
I think the previous version was more useful, because it had a link to the actual article. The article page has a button to export citation in BibTeX or RIS format.
Can you replace the bibtex below with human readable citation (as was before) that has a link to the Journal article? Feel free to shorten the authors list to Jarrod R. McClean et al.
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.
This replaces the reStructuredText version of the README file with a Markdown version, for better compatibility with our practices in our other repos. In addition, it removes the OpenFermion logo to follow the updated branding guidelines for Quantum AI. It also slightly reorganizes the content, as well as provides a BibTeX version of the citation info, and finally, adds the standard Google disclaimer and our QAI logo at the bottom.