Skip to content

PennyLaneAI/pennylane-cirq

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

PennyLane-Cirq Plugin

GitHub Workflow Status (branch) Codecov coverage CodeFactor Grade Read the Docs PyPI PyPI - Python Version

The PennyLane-Cirq plugin integrates the Cirq quantum computing framework with PennyLane's quantum machine learning capabilities.

PennyLane is a cross-platform Python library for quantum machine learning, automatic differentiation, and optimization of hybrid quantum-classical computations.

Cirq is a software library for quantum computing.

The plugin documentation can be found here: https://docs.pennylane.ai/projects/cirq.

Features

  • Provides access to built-in Cirq backends including cirq.simulator and cirq.mixedsimulator
  • Provides access to Pasqal's neutral-atom devices via cirq.pasqal
  • Provides access to the simulators qsim and qsimh via the cirq.qsim and cirq.qsimh devices
  • Support for all PennyLane core functionality

Installation

This plugin requires Python version 3.7 or above, as well as PennyLane and Cirq. Installation of this plugin, as well as all dependencies, can be done using pip:

$ pip install pennylane-cirq

Alternatively, you can install PennyLane-Cirq from the source code by navigating to the top directory and running:

$ python setup.py install

Dependencies

PennyLane-Cirq requires the following libraries be installed:

as well as the following Python packages:

To use the qsim and qsimh devices, the qsim-Cirq interface qsimcirq is required:

It can be installed using pip:

$ pip install qsimcirq

If you currently do not have Python 3 installed, we recommend Anaconda for Python 3, a distributed version of Python packaged for scientific computation.

Tests

To test that the PennyLane-Cirq plugin is working correctly you can run

$ make test

in the source folder.

Documentation

To build the HTML documentation, go to the top-level directory and run:

$ make docs

The documentation can then be found in the doc/_build/html/ directory.

Contributing

We welcome contributions - simply fork the repository of this plugin, and then make a pull request containing your contribution. All contributers to this plugin 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.

Authors

PennyLane-Cirq is the work of many contributors.

If you are doing research using PennyLane and PennyLane-Cirq, please cite our paper:

Ville Bergholm, Josh Izaac, Maria Schuld, Christian Gogolin, M. Sohaib Alam, Shahnawaz Ahmed, Juan Miguel Arrazola, Carsten Blank, Alain Delgado, Soran Jahangiri, Keri McKiernan, Johannes Jakob Meyer, Zeyue Niu, Antal Száva, and Nathan Killoran. PennyLane: Automatic differentiation of hybrid quantum-classical computations. 2018. arXiv:1811.04968

Support

If you are having issues, please let us know by posting the issue on our Github issue tracker, or by asking a question in the forum.

License

The PennyLane-Cirq plugin is free and open source, released under the Apache License, Version 2.0.

About

The PennyLane-Cirq plugin integrates Google's Cirq software library with with PennyLane's quantum machine learning capabilities.

Resources

License

Stars

Watchers

Forks

Packages

No packages published