{"id":13935730,"url":"https://github.com/rigetti/grove","last_synced_at":"2026-03-11T15:34:19.367Z","repository":{"id":43786380,"uuid":"77098216","full_name":"rigetti/grove","owner":"rigetti","description":"Quantum algorithms built using pyQuil.","archived":false,"fork":false,"pushed_at":"2021-12-02T19:36:56.000Z","size":4575,"stargazers_count":379,"open_issues_count":50,"forks_count":124,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-02-28T23:52:56.889Z","etag":null,"topics":["forest","quantum","quantum-algorithms","quantum-computing","rigetti-forest"],"latest_commit_sha":null,"homepage":"http://rigetti.com/forest","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rigetti.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-22T01:08:42.000Z","updated_at":"2024-12-13T12:24:31.000Z","dependencies_parsed_at":"2022-08-27T23:21:14.994Z","dependency_job_id":null,"html_url":"https://github.com/rigetti/grove","commit_stats":null,"previous_names":["rigetticomputing/grove"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fgrove","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fgrove/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fgrove/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rigetti%2Fgrove/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rigetti","download_url":"https://codeload.github.com/rigetti/grove/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294539,"owners_count":20915340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["forest","quantum","quantum-algorithms","quantum-computing","rigetti-forest"],"created_at":"2024-08-07T23:02:02.747Z","updated_at":"2025-12-12T00:54:33.849Z","avatar_url":"https://github.com/rigetti.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"Grove\n=====\n\nA collection of quantum algorithms built using the Rigetti Forest platform.\nGrove is licensed under the [Apache 2.0 license](https://github.com/rigetticomputing/grove/blob/master/LICENSE).\n\n[![Build Status](https://semaphoreci.com/api/v1/rigetti/grove/branches/master/badge.svg)](https://semaphoreci.com/rigetti/grove)\n[![Documentation Status](https://readthedocs.org/projects/grove-docs/badge/)](http://grove-docs.readthedocs.io/en/latest/)\n\nGrove currently includes:\n\n* [The Variational-Quantum-Eigensolver (VQE)](http://grove-docs.readthedocs.io/en/latest/vqe.html)\n* [The Quantum Approximate Optimization Algorithm (QAOA)](http://grove-docs.readthedocs.io/en/latest/qaoa.html)\n* [The Quantum Fourier Transform (QFT)](http://grove-docs.readthedocs.io/en/latest/qft.html)\n* [Phase Estimation Algorithm](http://grove-docs.readthedocs.io/en/latest/phaseestimation.html)\n\nFeatures in the `alpha` package are considered experimental.\n\nDocumentation\n-------------\n\nDocumentation is hosted at [http://grove-docs.readthedocs.io/en/latest/](http://grove-docs.readthedocs.io/en/latest/)\n\nInstallation\n------------\n\nYou can install Grove directly from the Python package manager `pip` using:\n```\npip install quantum-grove\n```\n\nTo instead install Grove from source, clone this repository, `cd` into it, and run:\n```\npip install -e .\n```\n\nThis will install Grove’s dependencies if you do not already have them.\nHowever, you will still need to install pyQuil and set up a connection to\nthe Rigetti Forest (see below).\nTo enable the tomography module, you will also have to install qutip\nand cvxpy, see below for more details.\n\nForest and pyQuil\n-----------------\n\nGrove also requires the Python library for Quil, called\n[pyQuil](http://pyquil.readthedocs.io/en/latest/index.html).\n\nYou can install pyQuil directly from the Python package manager `pip` using:\n```\npip install pyquil\n```\n\nTo instead install pyQuil from source, clone the\n[pyQuil GitHub repository](https://github.com/rigetticomputing/pyquil),\n`cd` into it, and run:\n```\npip install -e .\n```\n\nYou will need to make sure that your pyQuil installation is properly\nconfigured to run with a quantum virtual machine (QVM) or real quantum processor\n(QPU) hosted on the  [Rigetti Forest](forest.rigetti.com), which requires an API key.\nSee the pyQuil [docs](http://pyquil.readthedocs.io/en/latest/index.html) for\ninstructions on how to do this.\n\nInstalling the dependencies for Quantum Tomography\n--------------------------------------------------\n\nQuantum tomography relies on the external packages qutip and and cvxpy,\nwhich can be somewhat tricky to install.\n\nYou can first attempt to just run\n```\npip install -r requirements.txt\npip install -r optional-requirements.txt\npip install quantum-grove\n```\n\nIf the installation of the optional requirements fails, you can manually\ninstall the individual packages as\n\n```\npip install cython==0.24.1 scs==1.2.6\npip install qutip==4.1 cvxpy==0.4.11\n```\nThese are not the most recent versions but they are the only ones that\nhave consistently worked for us across different platforms and python\nversions.\n\nFor **Windows users**: Both qutip and cvxpy are fairly tricky to\ninstall under windows and we therefore recommend using Anaconda's\n``conda`` package manager to install these first and then ``pip``\nto install ``quantum-grove``.\n\n\nBuilding the Docs\n-----------------\n\nWe use sphinx to build the documentation. To do this, navigate into Grove's top-level directory and run:\n\n```\nsphinx-build -b html docs/ docs/_build\n```\n\nTo view the docs navigate to the newly-created `docs/_build` directory and open\nthe `index.html` file in a browser. Note that we use the Read the Docs theme for\nour documentation, so this may need to be installed using `pip install sphinx_rtd_theme`.\n\nDevelopment and Testing\n-----------------------\n\nWe use tox and pytest for testing. Tests can be executed from the top-level directory by simply\nrunning:\n```\ntox\n```\nThe setup is currently testing Python 2.7 and Python 3.6.\n\n\n## How to cite Grove and Forest\n\nIf you use pyquil, grove or other parts of Forest in your research, please cite it as follows:\n\nbibTeX:\n```\n@misc{1608.03355,\n  title={A Practical Quantum Instruction Set Architecture},\n  author={Smith, Robert S and Curtis, Michael J and Zeng, William J},\n  journal={arXiv preprint arXiv:1608.03355},\n  year={2016}\n}\n```\n\nText:\n```\nR. Smith, M. J. Curtis and W. J. Zeng, \"A Practical Quantum Instruction Set Architecture,\" (2015), \n  arXiv:1608.03355 [quant-ph], https://arxiv.org/abs/1608.03355\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frigetti%2Fgrove","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frigetti%2Fgrove","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frigetti%2Fgrove/lists"}