Skip to content
This repository was archived by the owner on Oct 7, 2019. It is now read-only.

Deprecate referenceqvm #22

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
[![Build Status](https://semaphoreci.com/api/v1/rigetti/reference-qvm/branches/master/badge.svg)](https://semaphoreci.com/rigetti/reference-qvm)
## Reference QVM is deprecated. Most of the features have been integrated into [pyQuil](https://github.com/rigetti/pyquil/) and are actively developed there.

# Reference QVM

The `referenceqvm` is the reference implementation of the QVM outlined in the
The `referenceqvm` was a reference implementation of the QVM outlined in the
arXiv:1608:03355 by Robert Smith, Spike Curtis, and Will Zeng. It is a research package that
supports rapid prototyping and development of quantum programs using pyQuil.

Currently, this QVM supports a subset of functionality in the Quil specifications,
excepting certain functions (DEFCIRCUIT, WAIT, NOP).
excepting certain functions (DEFCIRCUIT, WAIT, NOP), as well as prototypes for
Kraus operator noise simulations and CHP/clifford circuit simulation.

Noise models (dephasing, Kraus operators), parametrization with bits in
classical memory, and other features will be added in future releases.
The functionality prototyped in this repository has been integrated into [pyQuil](https://github.com/rigetti/pyquil/).

## PyQuil

`referenceqvm` functionality is now in pyQuil in the following modules: `unitary_tools.py`, `reference_simulator.py`, `gate_matrices.py`, and `pyqvm.py`. Additionally, there are more performant referenceqvm-style pure-python simulators in `numpy_simulator.py`. The clifford circuit simulation has not been ported, but we would love to accept that as a community contribution (with some clean-up and integration work to play nice with pyQuil).

## Installation

Expand Down