Metadata-Version: 2.1
Name: PennyLane-Forest
Version: 0.9.0
Summary: Rigetti backend for the PennyLane library
Home-page: http://rigetti.com
Maintainer: Rigetti Computing Inc.
Maintainer-email: sohaib@rigetti.com
License: BSD 3-Clause
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: pennylane_forest
Requires-Dist: pyquil (>=2.16)
Requires-Dist: pennylane (>=0.9)

PennyLane Forest Plugin
#######################

.. image:: https://semaphoreci.com/api/v1/rigetti/pennylane-forest/branches/master/badge.svg
    :alt: Build Status
    :target: https://semaphoreci.com/rigetti/pennylane-forest

.. image:: https://readthedocs.org/projects/pennylane-forest/badge/?version=latest
    :alt: Documentation Status
    :target: http://pennylane-forest.readthedocs.io/en/latest/?badge=latest

Contains the PennyLane Forest plugin. This plugin allows three Rigetti devices to work with PennyLane --- the wavefunction simulator, the Quantum Virtual Machine (QVM), and Quantum Processing Units (QPUs).

`pyQuil <https://pyquil.readthedocs.io>`_ is a Python library for quantum programming using the quantum instruction language (Quil) --- resulting quantum programs can be executed using the `Rigetti Forest SDK <https://www.rigetti.com/forest>`_ and the `Rigetti QCS <https://www.rigetti.com/qcs>`_.

`PennyLane <https://pennylane.readthedocs.io>`_ is a machine learning library for optimization and automatic differentiation of hybrid quantum-classical computations.


Features
========

* Provides four devices to be used with PennyLane: ``forest.numpy_wavefunction``, ``forest.wavefunction``, ``forest.qvm``, and ``forest.qpu``. These provide access to the pyQVM Numpy wavefunction simulator, Forest wavefunction simulator, quantum virtual machine (QVM), and quantum processing unit (QPU) respectively.


* All provided devices support all core qubit PennyLane operations and observables.


* Provides custom PennyLane operations to cover additional pyQuil operations: ``T``, ``S``, ``ISWAP``, ``CCNOT``, ``PSWAP``, and many more. Every custom operation supports analytic differentiation.

* Combine Forest and the Rigetti Cloud Services with PennyLane's automatic differentiation and optimization.


Installation
============

PennyLane-Forest requires both PennyLane and pyQuil. It can be installed via ``pip``:

.. code-block:: bash

    $ python -m pip install pennylane-forest


Getting started
===============

Once the PennyLane-Forest plugin is installed, the three provided pyQuil devices can be accessed straight away in PennyLane.

You can instantiate these devices for PennyLane as follows:

.. code-block:: python

    import pennylane as qml
    dev_numpy = qml.device('forest.numpy_wavefunction', wires=2)
    dev_simulator = qml.device('forest.wavefunction', wires=2)
    dev_pyqvm = qml.device('forest.qvm', device='2q-pyqvm', shots=1000)
    dev_qvm = qml.device('forest.qvm', device='2q-qvm', shots=1000)
    dev_qpu = qml.device('forest.qpu', device='Aspen-0-12Q-A', shots=1000)

These devices can then be used just like other devices for the definition and evaluation of QNodes within PennyLane. For more details, see the `plugin usage guide <https://pennylane-forest.readthedocs.io/en/latest/usage.html>`_ and refer to the PennyLane documentation.


Contributing
============

We welcome contributions - simply fork the PennyLane-Forest repository, and then make a
`pull request <https://help.github.com/articles/about-pull-requests/>`_ containing your contribution.  All contributers to PennyLane-Forest will be listed as authors on the releases.

We also encourage bug reports, suggestions for new features and enhancements, and even links to cool projects or applications built on PennyLane and pyQuil.


Authors
=======

`Josh Izaac <https://github.com/josh146>`_, `Keri A. McKiernan <https://github.com/kmckiern>`_, `M. Sohaib Alam <https://github.com/msohaibalam>`_, `Johannes Jakob Meyer <https://github.com/johannesjmeyer>`_


Support
=======

- **Source Code:** https://github.com/rigetti/pennylane-forest
- **Issue Tracker:** https://github.com/rigetti/pennylane-forest/issues

If you are having issues, please let us know by posting the issue on our Github issue tracker.


License
=======

PennyLane-Forest is **free** and **open source**, released under the BSD 3-Clause `license <https://github.com/rigetti/pennylane-forest/blob/master/LICENSE>`_.


