From 44d5f7f364fcac7d5aeebb8a747a972fedebcae9 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Thu, 25 Sep 2025 16:22:50 -0700 Subject: [PATCH 1/7] Replace README.rst with Markdown version & update content 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. --- README.md | 226 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 223 ---------------------------------------------------- 2 files changed, 226 insertions(+), 223 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 000000000..d57946a20 --- /dev/null +++ b/README.md @@ -0,0 +1,226 @@ +
+ +# OpenFermion + +Electronic structure package for quantum computers. + +[![Compatible with Python versions 3.10 and higher](https://img.shields.io/badge/Python-3.10+-fcbc2c.svg?style=flat-square&logo=python&logoColor=white)](https://www.python.org/downloads/) +[![Licensed under the Apache 2.0 license](https://img.shields.io/badge/License-Apache%202.0-3c60b1.svg?logo=opensourceinitiative&logoColor=white&style=flat-square)](https://github.com/quantumlib/OpenFermion/blob/main/LICENSE) +[![OpenFermion project on PyPI](https://img.shields.io/pypi/v/OpenFermion.svg?logo=semantic-release&logoColor=white&label=Release&style=flat-square&color=fcbc2c)](https://pypi.org/project/OpenFermion) +[![OpenFermion downloads per month from PyPI](https://img.shields.io/pypi/dm/openfermion?logo=PyPI&color=d56420&logoColor=white&style=flat-square&label=Downloads)](https://img.shields.io/pypi/dm/OpenFermion) + +[Features](#features) – +[Installation](#installation) – +[Plugins](#plugins) – +[Documentation](#cirq-documentation) – +[Contributing](#how-to-contribute) – +[Citing](#citing-openfermion) – +[Authors](#authors) – +[Contact](#contact) + +
+ +## Features + +OpenFermion is an open-source Python package for compiling and analyzing quantum algorithms to +simulate fermionic systems, including quantum chemistry. Among other features, it includes data +structures and tools for obtaining and manipulating representations of fermionic and qubit +Hamiltonians. More information can be found in the [release +paper](https://arxiv.org/abs/1710.07629). + +## Installation + +Installing the latest **stable** OpenFermion requires the Python package installer +[pip](https://pip.pypa.io). (Make sure that you are using an up-to-date version of it.) + +Currently, OpenFermion is tested on Mac, Windows, and Linux. We recommend using Mac or Linux because +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 +image provides a virtual environment with OpenFermion and select plugins pre-installed. The Docker +installation should run on any operating system where Docker can be used. + +### User installation + +To install the latest PyPI release of OpenFermion as a Python package in user mode, run the +following commands: + +```shell +python -m pip install --user openfermion +``` + +### Developer installation + +To install the latest version of OpenFermion in development mode, run the following commands: + +```shell +git clone https://github.com/quantumlib/OpenFermion +cd OpenFermion +python -m pip install -e . +``` + +## Plugins + +OpenFermion relies on modular plugin packages for significant functionality. Specifically, plugins +are used to simulate and compile quantum circuits and to perform classical electronic structure +calculations. Follow the links below to learn more! + +#### High-performance simulators + +* [OpenFermion-FQE](https://github.com/quantumlib/OpenFermion-FQE) is a high-performance emulator + of fermionic quantum evolutions specified by a sequence of fermion operators, which can exploit + fermionic symmetries such as spin and particle number. + +#### Circuit compilation plugins + +* [Forest-OpenFermion](https://github.com/rigetticomputing/forestopenfermion) to support + integration with [Forest](https://www.rigetti.com/forest). +* [SFOpenBoson](https://github.com/XanaduAI/SFOpenBoson) to support integration with [Strawberry + Fields](https://github.com/XanaduAI/strawberryfields). + +#### Electronic structure package plugins + +* [OpenFermion-Psi4](http://github.com/quantumlib/OpenFermion-Psi4) to support integration with + [Psi4](http://psicode.org). +* [OpenFermion-PySCF](http://github.com/quantumlib/OpenFermion-PySCF) to support integration with + [PySCF](https://github.com/sunqm/pyscf). +* [OpenFermion-Dirac](https://github.com/bsenjean/Openfermion-Dirac) to support integration with + [DIRAC](http://diracprogram.org/doku.php). +* [OpenFermion-QChem](https://github.com/qchemsoftware/OpenFermion-QChem) to support integration + with [Q-Chem](https://www.q-chem.com). + +## Documentation + +Documentation for OpenFermion can be found at +[quantumai.google/openfermion](https://quantumai.google/openfermion) and the following links: + +* [Installation](https://quantumai.google/openfermion/install) +* [API Docs](https://quantumai.google/reference/python/openfermion/all_symbols) +* [Tutorials](https://quantumai.google/openfermion/tutorials/intro_to_openfermion) + +You can run OpenFermion's interactive Jupyter Notebooks in +[Colab](https://colab.research.google.com/github/quantumlib/OpenFermion) or +[MyBinder](https://mybinder.org/v2/gh/quantumlib/OpenFermion/master?filepath=examples). + +## Contributing to OpenFermion + +We'd love to accept your contributions and patches to OpenFermion. There are a few small guidelines +you need to follow. + +* Contributions to OpenFermion must be accompanied by a Contributor License Agreement (CLA). You + (or your employer) retain the copyright to your contribution; the CLA simply gives us permission + to use and redistribute your contributions as part of the OpenFermion project. Please visit + https://cla.developers.google.com/ to see your current agreements on file or to sign a new one. +* All submissions, including submissions by project members, require review. We use GitHub pull + requests for this purpose. Consult the appropriate [GitHub Help + documentation](https://help.github.com/articles/about-pull-requests/) for more information on + using pull requests. +* Please make sure your new code comes with extensive tests! We use automatic testing to make sure + all pull requests pass tests and do not decrease overall test coverage by too much. +* Please also make sure to follow the OpenFermion source code style. We mostly follow Python's + [PEP 8](https://www.python.org/dev/peps/pep-0008/) guidelines and use the corresponding + [linter](https://pypi.python.org/pypi/pep8) to check for it. +* Code should always be accompanied by documentation. Formatted OpenFermion documentation is + generated automatically and can be found [on the Quantum AI web + site](http://openfermion.readthedocs.io/en/latest/openfermion.html). +* We use [Github issues](https://github.com/quantumlib/OpenFermion/issues) for tracking requests + and bugs. Please post questions to the [Quantum Computing Stack + Exchange](https://quantumcomputing.stackexchange.com/) with an 'openfermion' tag. + +## Citing OpenFermion + +When using OpenFermion for research projects, please cite: + +```bibtex +@article{McClean_2020, + author = {Jarrod R. McClean and Nicholas C. Rubin and Kevin J. Sung + and Ian D. Kivlichan and Xavier Bonet-Monroig and Yudong Cao + and Chengyu Dai and E. Schuyler Fried and Craig Gidney + and Brendan Gimby and Pranav Gokhale and Thomas Häner + and Tarini Hardikar and Vojtěch Havlíček and Oscar Higgott + and Cupjin Huang and Josh Izaac and Zhang Jiang + and Xinle Liu and Sam McArdle and Matthew Neeley + and Thomas O’Brien and Bryan O’Gorman and Isil Ozfidan + and Maxwell D. Radin and Jhonathan Romero + and Nicolas P. D. Sawaya and Bruno Senjean and Kanav Setia + and Sukin Sim and Damian S. Steiger and Mark Steudtner + and Qiming Sun and Wei Sun and Daochen Wang and Fang Zhang + and Ryan Babbush}, + year = 2020, + month = jun, + publisher = {IOP Publishing}, + volume = 5, + number = 3, + pages = {034014}, + title = {{OpenFermion}: The Electronic Structure Package for + Quantum Computers}, + journal = {Quantum Science and Technology}, +} +``` + +We are happy to include future contributors as authors on later releases. + +## Authors + +[Ryan Babbush](https://ryanbabbush.com) (Google), +[Jarrod McClean](https://jarrodmcclean.com) (Google), +[Nicholas Rubin](https://github.com/ncrubin) (Google), +[Kevin Sung](https://github.com/kevinsung) (University of Michigan), +[Ian Kivlichan](https://aspuru.chem.harvard.edu/ian-kivlichan/) (Harvard), +[Dave Bacon](https://github.com/dabacon) (Google), +[Xavier Bonet-Monroig](https://github.com/xabomon) (Leiden University), +[Yudong Cao](https://github.com/yudongcao) (Harvard), +[Chengyu Dai](https://github.com/jdaaph) (University of Michigan), +[E. Schuyler Fried](https://github.com/schuylerfried) (Harvard), +[Craig Gidney](https://github.com/Strilanc) (Google), +[Brendan Gimby](https://github.com/bgimby) (University of Michigan), +[Pranav Gokhale](https://github.com/singular-value) (University of Chicago), +[Thomas Häner](https://github.com/thomashaener) (ETH Zurich), +[Tarini Hardikar](https://github.com/TariniHardikar) (Dartmouth), +[Vojtĕch Havlíček](https://github.com/VojtaHavlicek) (Oxford), +[Oscar Higgott](https://github.com/oscarhiggott) (University College London), +[Cupjin Huang](https://github.com/pertoX4726) (University of Michigan), +[Josh Izaac](https://github.com/josh146) (Xanadu), +[Zhang Jiang](https://ti.arc.nasa.gov/profile/zjiang3) (NASA), +[William Kirby](https://williammkirby.com) (Tufts University), +[Xinle Liu](https://github.com/sheilaliuxl) (Google), +[Sam McArdle](https://github.com/sammcardle30) (Oxford), +[Matthew Neeley](https://github.com/maffoo) (Google), +[Thomas O'Brien](https://github.com/obriente) (Leiden University), +[Bryan O'Gorman](https://ti.arc.nasa.gov/profile/bogorman) (UC Berkeley, NASA), +[Isil Ozfidan](https://github.com/conta877) (D-Wave Systems), +[Max Radin](https://github.com/max-radin) (UC Santa Barbara), +[Jhonathan Romero](https://github.com/jromerofontalvo) (Harvard), +[Daniel Sank](https://github.com/DanielSank) (Google), +[Nicolas Sawaya](https://github.com/nicolassawaya) (Harvard), +[Bruno Senjean](https://github.com/bsenjean) (Leiden University), +[Kanav Setia](https://github.com/kanavsetia) (Dartmouth), +[Hannah Sim](https://github.com/hsim13372) (Harvard), +[Damian Steiger](https://github.com/damiansteiger) (ETH Zurich), +[Mark Steudtner](https://github.com/msteudtner) (Leiden University), +[Qiming Sun](https://github.com/sunqm) (Caltech), +[Wei Sun](https://github.com/Spaceenter) (Google), +[Daochen Wang](https://github.com/daochenw) (River Lane Research), +[Chris Winkler](https://github.com/quid256) (University of Chicago), +[Fang Zhang](https://github.com/fangzh-umich) (University of Michigan), +and [Emiel Koridon](https://github.com/Emieeel) (Leiden University). + +## Contact + +For any questions or concerns not addressed here, please email quantum-oss-maintainers@google.com. + +## Disclaimer + +This is not an officially-supported Google product. This project is not eligible for the [Google +Open Source Software Vulnerability Rewards +Program](https://bughunters.google.com/open-source-security). + +Copyright 2017 The OpenFermion Developers. + +
+ + Google Quantum AI + +
diff --git a/README.rst b/README.rst deleted file mode 100644 index cc3fb316f..000000000 --- a/README.rst +++ /dev/null @@ -1,223 +0,0 @@ -.. image:: https://raw.githubusercontent.com/quantumlib/OpenFermion/refs/heads/master/docs/images/logo_horizontal.svg - :alt: OpenFermion logo - :width: 75% - :align: center - -.. |python| image:: https://img.shields.io/badge/Python-3.10+-fcbc2c.svg?style=flat-square&logo=python&logoColor=white - :alt: Compatible with Python versions 3.10 and higher - :target: https://www.python.org/downloads/ - -.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-3c60b1.svg?logo=opensourceinitiative&logoColor=white&style=flat-square - :alt: Licensed under the Apache 2.0 license - :target: https://github.com/quantumlib/OpenFermion/blob/main/LICENSE - -.. |version| image:: https://img.shields.io/pypi/v/OpenFermion.svg?logo=semantic-release&logoColor=white&label=Release&style=flat-square&color=fcbc2c - :alt: OpenFermion project on PyPI - :target: https://pypi.org/project/OpenFermion - -.. |downloads| image:: https://img.shields.io/pypi/dm/openfermion?logo=PyPI&color=d56420&logoColor=white&style=flat-square&label=Downloads - :alt: OpenFermion downloads per month from PyPI - :target: https://img.shields.io/pypi/dm/OpenFermion - -.. class:: margin-top -.. class:: centered - -| -| |python| |license| |version| |downloads| - -.. |vertspace| image:: https://upload.wikimedia.org/wikipedia/commons/archive/c/ca/20200404084254%211x1.png - :alt: Blank space - :width: 1px - :height: 30px - -|vertspace| OpenFermion is an open-source library for compiling and analyzing quantum -algorithms to simulate fermionic systems, including quantum chemistry. Among -other features, it includes data structures and tools for obtaining and -manipulating representations of fermionic and qubit Hamiltonians. For more -information, see our `release paper `__. - -You can run the interactive Jupyter Notebooks in |Colab|_ or |MyBinder|_. - -.. |Colab| replace:: Colab -.. _Colab: https://colab.research.google.com/github/quantumlib/OpenFermion - -.. |MyBinder| replace:: MyBinder -.. _MyBinder: https://mybinder.org/v2/gh/quantumlib/OpenFermion/master?filepath=examples - -Installation and Documentation -============================== - -Installing the latest **stable** OpenFermion requires the Python package -installer `pip `__. Make sure that you are using an -up-to-date version of it. - -Documentation can be found at `quantumai.google/openfermion `__ and the following links: - -* `Installation `__ - -* `API Docs `__ - -* `Tutorials `__ - -Currently, OpenFermion is tested on Mac, Windows, and Linux. We recommend using Mac or Linux because -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 a Docker image -and usage instructions in the -`docker folder `__. -The Docker image provides a virtual environment with OpenFermion and select plugins pre-installed. -The Docker installation should run on any operating system where Docker can be used. - -Developer install ------------------ - -To install the latest version of OpenFermion (in development mode), run -the following commands: - -.. code-block:: shell - - git clone https://github.com/quantumlib/OpenFermion - cd OpenFermion - python -m pip install -e . - -Library install ---------------- - -To install the latest PyPI release as a library (in user mode), run -the following commands: - -.. code-block:: shell - - python -m pip install --user openfermion - -Plugins -======= - -OpenFermion relies on modular plugin libraries for significant functionality. -Specifically, plugins are used to simulate and compile quantum circuits and to perform -classical electronic structure calculations. -Follow the links below to learn more! - -High-performance simulators ---------------------------- - -* `OpenFermion-FQE `__ is - a high-performance emulator of fermionic quantum evolutions specified - by a sequence of fermion operators, which can exploit fermionic - symmetries such as spin and particle number. - -Circuit compilation plugins ---------------------------- - -* `Forest-OpenFermion `__ to support integration with `Forest `__. - -* `SFOpenBoson `__ to support integration with `Strawberry Fields `__. - -Electronic structure package plugins ------------------------------------- - -* `OpenFermion-Psi4 `__ to support integration with `Psi4 `__. - -* `OpenFermion-PySCF `__ to support integration with `PySCF `__. - -* `OpenFermion-Dirac `__ to support integration with `DIRAC `__. - -* `OpenFermion-QChem `__ to support integration with `Q-Chem `__. - -How to contribute -================= - -We'd love to accept your contributions and patches to OpenFermion. -There are a few small guidelines you need to follow. -Contributions to OpenFermion must be accompanied by a Contributor License -Agreement (CLA). -You (or your employer) retain the copyright to your contribution; the CLA -this simply gives us permission to use and redistribute your contributions as part of the project. -Head over to https://cla.developers.google.com/ -to see your current agreements on file or to sign a new one. - -All submissions, including submissions by project members, require review. -We use GitHub pull requests for this purpose. Consult -`GitHub Help `__ for -more information on using pull requests. -Furthermore, please make sure your new code comes with extensive tests! -We use automatic testing to make sure all pull requests pass tests and do not -decrease overall test coverage by too much. Make sure you adhere to our style -guide. Just have a look at our code for clues. We mostly follow -`PEP 8 `_ and use -the corresponding `linter `_ to check for it. -Code should always come with documentation, which is generated automatically and can be found -`here `_. - -We use `Github issues `__ -for tracking requests and bugs. Please post questions to the -`Quantum Computing Stack Exchange `__ with an 'openfermion' tag. - -Authors -======= - -`Ryan Babbush `__ (Google), -`Jarrod McClean `__ (Google), -`Nicholas Rubin `__ (Google), -`Kevin Sung `__ (University of Michigan), -`Ian Kivlichan `__ (Harvard), -`Dave Bacon `__ (Google), -`Xavier Bonet-Monroig `__ (Leiden University), -`Yudong Cao `__ (Harvard), -`Chengyu Dai `__ (University of Michigan), -`E. Schuyler Fried `__ (Harvard), -`Craig Gidney `__ (Google), -`Brendan Gimby `__ (University of Michigan), -`Pranav Gokhale `__ (University of Chicago), -`Thomas Häner `__ (ETH Zurich), -`Tarini Hardikar `__ (Dartmouth), -`Vojtĕch Havlíček `__ (Oxford), -`Oscar Higgott `__ (University College London), -`Cupjin Huang `__ (University of Michigan), -`Josh Izaac `__ (Xanadu), -`Zhang Jiang `__ (NASA), -`William Kirby `__ (Tufts University), -`Xinle Liu `__ (Google), -`Sam McArdle `__ (Oxford), -`Matthew Neeley `__ (Google), -`Thomas O'Brien `__ (Leiden University), -`Bryan O'Gorman `__ (UC Berkeley, NASA), -`Isil Ozfidan `__ (D-Wave Systems), -`Max Radin `__ (UC Santa Barbara), -`Jhonathan Romero `__ (Harvard), -`Daniel Sank `__ (Google), -`Nicolas Sawaya `__ (Harvard), -`Bruno Senjean `__ (Leiden University), -`Kanav Setia `__ (Dartmouth), -`Hannah Sim `__ (Harvard), -`Damian Steiger `__ (ETH Zurich), -`Mark Steudtner `__ (Leiden University), -`Qiming Sun `__ (Caltech), -`Wei Sun `__ (Google), -`Daochen Wang `__ (River Lane Research), -`Chris Winkler `__ (University of Chicago), -`Fang Zhang `__ (University of Michigan) and -`Emiel Koridon `__ (Leiden University). - -How to cite -=========== - -When using OpenFermion for research projects, please cite: - - Jarrod R McClean, Nicholas C Rubin, Kevin J Sung, Ian D Kivlichan, Xavier Bonet-Monroig, - Yudong Cao, Chengyu Dai, E Schuyler Fried, Craig Gidney, Brendan Gimby, Pranav Gokhale, - Thomas Häner, Tarini Hardikar, Vojtěch Havlíček, Oscar Higgott, Cupjin Huang, Josh Izaac, - Zhang Jiang, Xinle Liu, Sam McArdle, Matthew Neeley, Thomas O'Brien, Bryan O'Gorman, - Isil Ozfidan, Maxwell D Radin, Jhonathan Romero, Nicolas P D Sawaya, Bruno Senjean, - Kanav Setia, Sukin Sim, Damian S Steiger, Mark Steudtner, Qiming Sun, Wei Sun, Daochen Wang, - Fang Zhang, and Ryan Babbush - *OpenFermion: The Electronic Structure Package for Quantum Computers*. - `Quantum Science and Technology 5.3 (2020): 034014 `__. - -We are happy to include future contributors as authors on later releases. - -Disclaimer -========== - -Copyright 2017 The OpenFermion Developers. -This is not an official Google product. From 622c705e27595e23f7a03beab7196634aadd1f68 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Thu, 25 Sep 2025 16:23:09 -0700 Subject: [PATCH 2/7] Add QAI logo image This adds the same QAI logo image used in our other repos. --- docs/images/quantum-ai-vertical.svg | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/images/quantum-ai-vertical.svg diff --git a/docs/images/quantum-ai-vertical.svg b/docs/images/quantum-ai-vertical.svg new file mode 100644 index 000000000..b41872775 --- /dev/null +++ b/docs/images/quantum-ai-vertical.svg @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + From df24c273dc56020d6a5a661a0e4ddbc0a40e8b9d Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Thu, 25 Sep 2025 16:28:00 -0700 Subject: [PATCH 3/7] Fix minor heading & link errors --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d57946a20..6cdeaa467 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ Electronic structure package for quantum computers. [Features](#features) – [Installation](#installation) – [Plugins](#plugins) – -[Documentation](#cirq-documentation) – -[Contributing](#how-to-contribute) – +[Documentation](#documentation) – +[Contributing](#contributing-to-openfermion) – [Citing](#citing-openfermion) – [Authors](#authors) – [Contact](#contact) @@ -66,20 +66,20 @@ OpenFermion relies on modular plugin packages for significant functionality. Spe are used to simulate and compile quantum circuits and to perform classical electronic structure calculations. Follow the links below to learn more! -#### High-performance simulators +### High-performance simulators * [OpenFermion-FQE](https://github.com/quantumlib/OpenFermion-FQE) is a high-performance emulator of fermionic quantum evolutions specified by a sequence of fermion operators, which can exploit fermionic symmetries such as spin and particle number. -#### Circuit compilation plugins +### Circuit compilation plugins * [Forest-OpenFermion](https://github.com/rigetticomputing/forestopenfermion) to support integration with [Forest](https://www.rigetti.com/forest). * [SFOpenBoson](https://github.com/XanaduAI/SFOpenBoson) to support integration with [Strawberry Fields](https://github.com/XanaduAI/strawberryfields). -#### Electronic structure package plugins +### Electronic structure package plugins * [OpenFermion-Psi4](http://github.com/quantumlib/OpenFermion-Psi4) to support integration with [Psi4](http://psicode.org). From 5336a22090a73c126a47faed0a7196334d8fe627 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Thu, 25 Sep 2025 16:30:01 -0700 Subject: [PATCH 4/7] Fix a few typos --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6cdeaa467..1295bb590 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ you need to follow. * Code should always be accompanied by documentation. Formatted OpenFermion documentation is generated automatically and can be found [on the Quantum AI web site](http://openfermion.readthedocs.io/en/latest/openfermion.html). -* We use [Github issues](https://github.com/quantumlib/OpenFermion/issues) for tracking requests +* We use [GitHub issues](https://github.com/quantumlib/OpenFermion/issues) for tracking requests and bugs. Please post questions to the [Quantum Computing Stack Exchange](https://quantumcomputing.stackexchange.com/) with an 'openfermion' tag. From 4e6f0eea72df6b243e3d93b4d34732a6cd35d858 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Thu, 25 Sep 2025 16:42:00 -0700 Subject: [PATCH 5/7] More tweaks --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1295bb590..38a985ace 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,8 @@ installation should run on any operating system where Docker can be used. ### User installation -To install the latest PyPI release of OpenFermion as a Python package in user mode, run the -following commands: +To install the latest PyPI release of OpenFermion as a Python package for the current user (which +avoids modifying system Python packages), run the following command: ```shell python -m pip install --user openfermion @@ -99,9 +99,10 @@ Documentation for OpenFermion can be found at * [API Docs](https://quantumai.google/reference/python/openfermion/all_symbols) * [Tutorials](https://quantumai.google/openfermion/tutorials/intro_to_openfermion) -You can run OpenFermion's interactive Jupyter Notebooks in -[Colab](https://colab.research.google.com/github/quantumlib/OpenFermion) or -[MyBinder](https://mybinder.org/v2/gh/quantumlib/OpenFermion/master?filepath=examples). +You can run OpenFermion's interactive Jupyter Notebooks, such as the introductory tutorial, in +[Colab](https://colab.research.google.com/github/quantumlib/OpenFermion/blob/master/examples/intro_to_openfermion.ipynb) +or +[MyBinder](https://mybinder.org/v2/gh/quantumlib/OpenFermion/master?filepath=examples%2Fintro_to_openfermion.ipynb). ## Contributing to OpenFermion @@ -123,10 +124,10 @@ you need to follow. [linter](https://pypi.python.org/pypi/pep8) to check for it. * Code should always be accompanied by documentation. Formatted OpenFermion documentation is generated automatically and can be found [on the Quantum AI web - site](http://openfermion.readthedocs.io/en/latest/openfermion.html). + site](https://quantumai.google/openfermion). * We use [GitHub issues](https://github.com/quantumlib/OpenFermion/issues) for tracking requests and bugs. Please post questions to the [Quantum Computing Stack - Exchange](https://quantumcomputing.stackexchange.com/) with an 'openfermion' tag. + Exchange](https://quantumcomputing.stackexchange.com/) with an `openfermion` tag. ## Citing OpenFermion From c7be582c85f55cf818218bc5bc9db97c68837b75 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Thu, 9 Oct 2025 11:25:32 -0700 Subject: [PATCH 6/7] Revert to showing formatted citation instead of bibtex Per discussion with @pavoljuhas in the [review comments](https://github.com/quantumlib/OpenFermion/pull/1143#discussion_r2403394881). --- README.md | 44 +++++++++++++++----------------------------- 1 file changed, 15 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 38a985ace..efc4afbe9 100644 --- a/README.md +++ b/README.md @@ -131,36 +131,20 @@ you need to follow. ## Citing OpenFermion -When using OpenFermion for research projects, please cite: - -```bibtex -@article{McClean_2020, - author = {Jarrod R. McClean and Nicholas C. Rubin and Kevin J. Sung - and Ian D. Kivlichan and Xavier Bonet-Monroig and Yudong Cao - and Chengyu Dai and E. Schuyler Fried and Craig Gidney - and Brendan Gimby and Pranav Gokhale and Thomas Häner - and Tarini Hardikar and Vojtěch Havlíček and Oscar Higgott - and Cupjin Huang and Josh Izaac and Zhang Jiang - and Xinle Liu and Sam McArdle and Matthew Neeley - and Thomas O’Brien and Bryan O’Gorman and Isil Ozfidan - and Maxwell D. Radin and Jhonathan Romero - and Nicolas P. D. Sawaya and Bruno Senjean and Kanav Setia - and Sukin Sim and Damian S. Steiger and Mark Steudtner - and Qiming Sun and Wei Sun and Daochen Wang and Fang Zhang - and Ryan Babbush}, - year = 2020, - month = jun, - publisher = {IOP Publishing}, - volume = 5, - number = 3, - pages = {034014}, - title = {{OpenFermion}: The Electronic Structure Package for - Quantum Computers}, - journal = {Quantum Science and Technology}, -} -``` +OpenFermion is the work of many people. When using OpenFermion for research projects, please cite +the [published paper](https://iopscience.iop.org/article/10.1088/2058-9565/ab8ebc/meta): -We are happy to include future contributors as authors on later releases. +> Jarrod R McClean, Nicholas C Rubin, Kevin J Sung, Ian D Kivlichan, Xavier Bonet-Monroig, Yudong +> Cao, Chengyu Dai, E Schuyler Fried, Craig Gidney, Brendan Gimby, Pranav Gokhale, Thomas Häner, +> Tarini Hardikar, Vojtěch Havlíček, Oscar Higgott, Cupjin Huang, Josh Izaac, Zhang Jiang, Xinle +> Liu, Sam McArdle, Matthew Neeley, Thomas O'Brien, Bryan O'Gorman, Isil Ozfidan, Maxwell D Radin, +> Jhonathan Romero, Nicolas P D Sawaya, Bruno Senjean, Kanav Setia, Sukin Sim, Damian S Steiger, +> Mark Steudtner, Qiming Sun, Wei Sun, Daochen Wang, Fang Zhang, and Ryan Babbush. (2020). +> OpenFermion: The Electronic Structure Package for Quantum Computers. _Quantum Science and +> Technology_, 5(3), 034014. + +For formatted citations and records in other formats, as well as records for all releases of OpenFermion +past and present, please visit the [OpenFermion page on Zenodo](https://zenodo.org/records/15604843). ## Authors @@ -207,6 +191,8 @@ We are happy to include future contributors as authors on later releases. [Fang Zhang](https://github.com/fangzh-umich) (University of Michigan), and [Emiel Koridon](https://github.com/Emieeel) (Leiden University). +We are happy to include future contributors as authors on later releases. + ## Contact For any questions or concerns not addressed here, please email quantum-oss-maintainers@google.com. From 4546db412ab421ee13ad6f72c2547df1194d065f Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Thu, 9 Oct 2025 11:44:35 -0700 Subject: [PATCH 7/7] =?UTF-8?q?Update=20master=20=E2=86=92=20main,=20now?= =?UTF-8?q?=20that=20PR=20#1151=20is=20merged?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index efc4afbe9..1a2cc80f4 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Currently, OpenFermion is tested on Mac, Windows, and Linux. We recommend using 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 +[`docker/`](https://github.com/quantumlib/OpenFermion/tree/main/docker) subdirectory. The Docker image provides a virtual environment with OpenFermion and select plugins pre-installed. The Docker installation should run on any operating system where Docker can be used. @@ -100,9 +100,9 @@ Documentation for OpenFermion can be found at * [Tutorials](https://quantumai.google/openfermion/tutorials/intro_to_openfermion) You can run OpenFermion's interactive Jupyter Notebooks, such as the introductory tutorial, in -[Colab](https://colab.research.google.com/github/quantumlib/OpenFermion/blob/master/examples/intro_to_openfermion.ipynb) +[Colab](https://colab.research.google.com/github/quantumlib/OpenFermion/blob/main/examples/intro_to_openfermion.ipynb) or -[MyBinder](https://mybinder.org/v2/gh/quantumlib/OpenFermion/master?filepath=examples%2Fintro_to_openfermion.ipynb). +[MyBinder](https://mybinder.org/v2/gh/quantumlib/OpenFermion/main?filepath=examples%2Fintro_to_openfermion.ipynb). ## Contributing to OpenFermion @@ -208,6 +208,6 @@ Copyright 2017 The OpenFermion Developers.