Skip to content

Huskyeder/grove

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grove

A collection of quantum algorithms built using Forest. Grove is licensed under the Apache 2.0 license.

Build Status

Grove currently includes algorithms for:

  • The Variational Quantum Eigensolver
  • The Quantum Approximate Optimization Algorithm
  • The Quantum Fourier Transform
  • Phase Estimation
  • Quantum Teleportation

Installation

Grove depends on pyQuil, numpy, scipy, networkx, pytest, mock, and matplotlib. To ensure binaries of these modules are installed along with the grove library we recommend installing with pip. First clone the Grove repo and cd into it.

git clone https://github.com/rigetticomputing/grove.git
cd grove

Now the library can be installed with pip.

pip install -e ./

In order to access the Rigetti Forest service an API key or configuration file will need to be installed. Please see the pyQuil documentation.

Dependencies

  • pyQuil
  • A Forest API key
  • Numpy
  • Scipy
  • Mock (for development testing)
  • NetworkX (for building and analyzing graphs)
  • Matplotlib (useful for plotting)

Building the Docs

To build the documentation run

sphinx-build -b html docs/ docs/_build

To view the docs navigate to the docs/_build directory in the Grove root directory and open the index.html file a browser.

About

Quantum algorithms built using pyQuil and Forest

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 72.9%
  • Jupyter Notebook 27.1%