Skip to main content

Open source library for continuous-variable quantum computation

Project description

Travis Codecov coverage Codacy grade Read the Docs PyPI PyPI - Python Version

This PennyLane plugin allows the Strawberry Fields simulators to be used as PennyLane devices.

Strawberry Fields is a full-stack Python library for designing, simulating, and optimizing continuous variable (CV) quantum optical circuits.

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

Features

  • Provides two devices to be used with PennyLane: strawberryfields.fock and strawberryfields.gaussian. These provide access to the Strawberry Fields Fock and Gaussian backends respectively.

  • Supports all core PennyLane operations and observables across the two devices.

  • Combine Strawberry Fields optimized simulator suite with PennyLane’s automatic differentiation and optimization.

Installation

PennyLane-SF requires both PennyLane and Strawberry Fields. It can be installed via pip:

$ python -m pip install pennylane-sf

Getting started

Once the PennyLane-SF plugin is installed, the two provided Strawberry Fields devices can be accessed straight away in PennyLane.

You can instantiate these devices for PennyLane as follows:

import pennylane as qml
dev_fock = qml.device('strawberryfields.fock', wires=2, cutoff_dim=10)
dev_gaussian = qml.device('strawberryfields.gaussian', wires=2)

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 and refer to the PennyLane documentation.

Contributing

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

Authors

Josh Izaac, Ville Bergholm, Maria Schuld, Nathan Killoran and Christian Gogolin

If you are doing research using PennyLane and StrawberryFields, please cite our papers:

Ville Bergholm, Josh Izaac, Maria Schuld, Christian Gogolin, and Nathan Killoran. PennyLane: Automatic differentiation of hybrid quantum-classical computations. 2018. arXiv:1811.04968

Nathan Killoran, Josh Izaac, Nicolás Quesada, Ville Bergholm, Matthew Amy, and Christian Weedbrook. Strawberry Fields: A Software Platform for Photonic Quantum Computing. 2018. arXiv:1804.03159

Support

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

We also have a Strawberry Fields Slack channel - come join the discussion and chat with our Strawberry Fields team.

License

PennyLane-SF 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 Distribution

PennyLane-SF-0.5.0.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

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

PennyLane_SF-0.5.0-py3-none-any.whl (16.4 kB view details)

Uploaded Python 3

File details

Details for the file PennyLane-SF-0.5.0.tar.gz.

File metadata

  • Download URL: PennyLane-SF-0.5.0.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for PennyLane-SF-0.5.0.tar.gz
Algorithm Hash digest
SHA256 df222eee46b06992daf540789a4b9f3b60a3a9edd325a243b95b72987b74914e
MD5 9539f40c44ef3c0e27295513f81725a4
BLAKE2b-256 24b9497e388f111e1cb6da8781da228c50e3833c35c1e4981f291262db7272bd

See more details on using hashes here.

File details

Details for the file PennyLane_SF-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: PennyLane_SF-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 16.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.6.8

File hashes

Hashes for PennyLane_SF-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36a7d38828338f466c12fc41548e5a8504ad110e50c2cdf7d82dcea7c17040b4
MD5 3c355698c5412a5134ad3c3b792e6312
BLAKE2b-256 aa206d180bb2f1063caa41a132b03b717cc6e07caf99ee8da252ce623a71b737

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