Skip to main content

PennyLane plugin for Cirq

Project description

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.11 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

It is recommended to install development requirements with,

$ python -m pip install -r requirements-dev.txt

This will install everything needed to run tests and make contributions.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pennylane_cirq-0.44.0-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file pennylane_cirq-0.44.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pennylane_cirq-0.44.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8d08a76b72501a31053a2649da818eb85293eea488c1323d3e13941b38ac6f1
MD5 85f06e3e4b7c3cf7bdea74fbe94dd061
BLAKE2b-256 42453f4338a809404da0cfd957dc8662f552ce1562594a83f85bff5f2200bc9d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page