Skip to content

Commit

Permalink
Clean up readme for new website (quantumlib#695)
Browse files Browse the repository at this point in the history
* Clean up readme for new website

Links to new website docs are now fixed.

The rtd_docs folder is added back with code for updating
Readthedocs with a page redirect to the new OpenFermion
landing page at https://quantumai.google/openfermion

* Remove old docs build dev_tools

We don't need this dev_tools anymore.

I am leaving the folder so we can populate it later
with tensorflow-docs autogeneration code.
  • Loading branch information
ncrubin committed Jul 25, 2022
1 parent 0e57289 commit 9f58ccd
Show file tree
Hide file tree
Showing 18 changed files with 269 additions and 992 deletions.
65 changes: 35 additions & 30 deletions README.rst
Expand Up @@ -15,7 +15,7 @@ Hamiltonians. For more information, see our
.. image:: https://readthedocs.org/projects/openfermion/badge/?version=latest
:target: http://openfermion.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://badge.fury.io/py/openfermion.svg
:target: https://badge.fury.io/py/openfermion

Expand All @@ -25,40 +25,22 @@ Run the interactive Jupyter Notebooks in Colab_ or MyBinder_:
.. _Colab: https://colab.research.google.com/github/quantumlib/OpenFermion
.. _MyBinder: https://mybinder.org/v2/gh/quantumlib/OpenFermion/master?filepath=examples

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!

Circuit compilation and simulation 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>`__.
Installation and Documentation
==============================

Electronic structure package plugins
------------------------------------
* `OpenFermion-Psi4 <http://github.com/quantumlib/OpenFermion-Psi4>`__ to support integration with `Psi4 <http://psicode.org>`__.
Installing the latest **stable** OpenFermion requires pip. Make sure that you are using an up-to-date version of it.

* `OpenFermion-PySCF <http://github.com/quantumlib/OpenFermion-PySCF>`__ to support integration with `PySCF <https://github.com/sunqm/pyscf>`__.
Documentation can be found at `quantumai.google/openfermion <https://quantumai.google/openfermion>`__ and the following links

* `OpenFermion-Dirac <https://github.com/bsenjean/Openfermion-Dirac>`__ to support integration with `DIRAC <http://diracprogram.org/doku.php>`__.
* `Installation <https://quantumai.google/openfermion/install>`__

Getting started
===============
* `API Docs <https://quantumai.google/reference/python/openfermion/all_symbols>`__

Installing OpenFermion requires pip. Make sure that you are using an up-to-date version of it.
For information about getting started beyond what is provided below please see our
`tutorial <https://github.com/quantumlib/OpenFermion/blob/master/docs/tutorials/intro_to_openfermion.ipynb>`__
in the
`tutorials <https://github.com/quantumlib/OpenFermion/blob/master/docs/tutorials>`__ folder
as well as our detailed `code documentation <http://openfermion.readthedocs.io/en/latest/openfermion.html>`__.
* `Tutorials <https://quantumai.google/openfermion/tutorials/intro_to_openfermion>`__

Currently, OpenFermion is only tested on Mac and Linux for the reason that both
electronic structure plugins are only compatible with Mac and Linux. However,
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 have provided a Docker image
and usage instructions in the
Expand All @@ -70,9 +52,10 @@ You might also want to explore the alpha release of the
`OpenFermion Cloud Library <https://github.com/quantumlib/OpenFermion/tree/master/cloud_library>`__
where users can share and download precomputed molecular benchmark files.

Check out other `projects and papers using OpenFermion <docs/projects.md>`__ for inspiration,
Check out other `projects and papers using OpenFermion <https://quantumai.google/openfermion/projects>`__ for inspiration,
and let us know if you've been using OpenFermion!


Developer install
-----------------

Expand All @@ -93,6 +76,28 @@ To install the latest PyPI release as a library (in user mode):
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!

Circuit compilation and simulation 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>`__.

How to contribute
=================

Expand Down Expand Up @@ -126,6 +131,7 @@ Authors

`Ryan Babbush <http://ryanbabbush.com>`__ (Google),
`Jarrod McClean <http://jarrodmcclean.com>`__ (Google),
`Nicholas Rubin <https://github.com/ncrubin>`__ (Google),
`Kevin Sung <https://github.com/kevinsung>`__ (University of Michigan),
`Ian Kivlichan <http://aspuru.chem.harvard.edu/ian-kivlichan/>`__ (Harvard),
`Dave Bacon <https://github.com/dabacon>`__ (Google),
Expand All @@ -152,7 +158,6 @@ Authors
`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),
`Nicholas Rubin <https://github.com/ncrubin>`__ (Google),
`Daniel Sank <https://github.com/DanielSank>`__ (Google),
`Nicolas Sawaya <https://github.com/nicolassawaya>`__ (Harvard),
`Bruno Senjean <https://github.com/bsenjean>`__ (Leiden University),
Expand Down
64 changes: 0 additions & 64 deletions dev_tools/docs/build_api_docs.py

This file was deleted.

0 comments on commit 9f58ccd

Please sign in to comment.