PennyLane-Cirq Plugin
######################
.. image:: https://img.shields.io/github/actions/workflow/status/PennyLaneAI/pennylane-cirq/tests.yml?branch=master&logo=github&style=flat-square
:alt: GitHub Workflow Status (branch)
:target: https://github.com/PennyLaneAI/pennylane-cirq/actions?query=workflow%3ATests
.. image:: https://img.shields.io/codecov/c/github/PennyLaneAI/pennylane-cirq/master.svg?logo=codecov&style=flat-square
:alt: Codecov coverage
:target: https://codecov.io/gh/PennyLaneAI/pennylane-cirq
.. image:: https://img.shields.io/codefactor/grade/github/PennyLaneAI/pennylane-cirq/master?logo=codefactor&style=flat-square
:alt: CodeFactor Grade
:target: https://www.codefactor.io/repository/github/pennylaneai/pennylane-cirq
.. image:: https://readthedocs.com/projects/xanaduai-pennylane-cirq/badge/?version=latest&style=flat-square
:alt: Read the Docs
:target: https://docs.pennylane.ai/projects/cirq
.. image:: https://img.shields.io/pypi/v/PennyLane-cirq.svg?style=flat-square
:alt: PyPI
:target: https://pypi.org/project/PennyLane-cirq
.. image:: https://img.shields.io/pypi/pyversions/PennyLane-cirq.svg?style=flat-square
:alt: PyPI - Python Version
:target: https://pypi.org/project/PennyLane-cirq
|
.. header-start-inclusion-marker-do-not-remove
The PennyLane-Cirq plugin integrates the Cirq quantum computing framework with PennyLane's
quantum machine learning capabilities.
`PennyLane <https://pennylane.readthedocs.io>`__ is a cross-platform Python library for quantum machine
learning, automatic differentiation, and optimization of hybrid quantum-classical computations.
`Cirq <https://github.com/quantumlib/Cirq>`__ is a software library for quantum computing.
.. header-end-inclusion-marker-do-not-remove
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-start-inclusion-marker-do-not-remove
Installation
============
This plugin requires Python version 3.10 or above, as well as PennyLane
and Cirq. Installation of this plugin, as well as all dependencies, can be done using ``pip``:
.. code-block:: bash
$ pip install pennylane-cirq
Alternatively, you can install PennyLane-Cirq from the `source code <https://github.com/PennyLaneAI/pennylane-cirq>`__
by navigating to the top directory and running:
.. code-block:: bash
$ python setup.py install
Dependencies
~~~~~~~~~~~~
PennyLane-Cirq requires the following libraries be installed:
* `Python <http://python.org/>`__ >= 3.10
as well as the following Python packages:
* `PennyLane <http://pennylane.readthedocs.io/>`__ >= 0.29
* `Cirq <https://cirq.readthedocs.io/>`__ >= 0.10.0
To use the qsim and qsimh devices, the qsim-Cirq interface ``qsimcirq`` is required:
* `qsimcirq <https://github.com/quantumlib/qsim/blob/master/docs/cirq_interface.md>`__
It can be installed using ``pip``:
.. code-block:: bash
$ pip install qsimcirq
If you currently do not have Python 3 installed, we recommend
`Anaconda for Python 3 <https://www.anaconda.com/download/>`__, a distributed version of Python packaged
for scientific computation.
Tests
~~~~~
To test that the PennyLane-Cirq plugin is working correctly you can run
.. code-block:: bash
$ make test
in the source folder.
Documentation
~~~~~~~~~~~~~
To build the HTML documentation, go to the top-level directory and run:
.. code-block:: bash
$ make docs
The documentation can then be found in the ``doc/_build/html/`` directory.
.. installation-end-inclusion-marker-do-not-remove
Contributing
============
We welcome contributions - simply fork the repository of this plugin, and then make a
`pull request <https://help.github.com/articles/about-pull-requests/>`__ 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 <https://github.com/PennyLaneAI/pennylane-cirq/graphs/contributors>`__.
If you are doing research using PennyLane and PennyLane-Cirq, please cite `our paper <https://arxiv.org/abs/1811.04968>`__:
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-start-inclusion-marker-do-not-remove
Support
=======
- **Source Code:** https://github.com/PennyLaneAI/pennylane-cirq
- **Issue Tracker:** https://github.com/PennyLaneAI/pennylane-cirq/issues
- **PennyLane Forum:** https://discuss.pennylane.ai
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.
.. support-end-inclusion-marker-do-not-remove
.. license-start-inclusion-marker-do-not-remove
License
=======
The PennyLane-Cirq plugin is **free** and **open source**, released under
the `Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`__.
.. license-end-inclusion-marker-do-not-remove
Raw data
{
"_id": null,
"home_page": "http://xanadu.ai",
"name": "PennyLane-Cirq",
"maintainer": "Xanadu Inc.",
"docs_url": null,
"requires_python": null,
"maintainer_email": "software@xanadu.ai",
"keywords": null,
"author": null,
"author_email": null,
"download_url": null,
"platform": null,
"description": "PennyLane-Cirq Plugin\n######################\n\n.. image:: https://img.shields.io/github/actions/workflow/status/PennyLaneAI/pennylane-cirq/tests.yml?branch=master&logo=github&style=flat-square\n :alt: GitHub Workflow Status (branch)\n :target: https://github.com/PennyLaneAI/pennylane-cirq/actions?query=workflow%3ATests\n\n.. image:: https://img.shields.io/codecov/c/github/PennyLaneAI/pennylane-cirq/master.svg?logo=codecov&style=flat-square\n :alt: Codecov coverage\n :target: https://codecov.io/gh/PennyLaneAI/pennylane-cirq\n\n.. image:: https://img.shields.io/codefactor/grade/github/PennyLaneAI/pennylane-cirq/master?logo=codefactor&style=flat-square\n :alt: CodeFactor Grade\n :target: https://www.codefactor.io/repository/github/pennylaneai/pennylane-cirq\n\n.. image:: https://readthedocs.com/projects/xanaduai-pennylane-cirq/badge/?version=latest&style=flat-square\n :alt: Read the Docs\n :target: https://docs.pennylane.ai/projects/cirq\n\n.. image:: https://img.shields.io/pypi/v/PennyLane-cirq.svg?style=flat-square\n :alt: PyPI\n :target: https://pypi.org/project/PennyLane-cirq\n\n.. image:: https://img.shields.io/pypi/pyversions/PennyLane-cirq.svg?style=flat-square\n :alt: PyPI - Python Version\n :target: https://pypi.org/project/PennyLane-cirq\n\n|\n\n.. header-start-inclusion-marker-do-not-remove\n\nThe PennyLane-Cirq plugin integrates the Cirq quantum computing framework with PennyLane's\nquantum machine learning capabilities.\n\n`PennyLane <https://pennylane.readthedocs.io>`__ is a cross-platform Python library for quantum machine\nlearning, automatic differentiation, and optimization of hybrid quantum-classical computations.\n\n`Cirq <https://github.com/quantumlib/Cirq>`__ is a software library for quantum computing.\n\n.. header-end-inclusion-marker-do-not-remove\n\nThe plugin documentation can be found here: `<https://docs.pennylane.ai/projects/cirq>`__.\n\nFeatures\n========\n\n* Provides access to built-in Cirq backends including ``cirq.simulator`` and ``cirq.mixedsimulator``\n\n* Provides access to Pasqal's neutral-atom devices via ``cirq.pasqal``\n\n* Provides access to the simulators qsim and qsimh via the ``cirq.qsim`` and ``cirq.qsimh`` devices\n\n* Support for all PennyLane core functionality\n\n.. installation-start-inclusion-marker-do-not-remove\n\nInstallation\n============\n\nThis plugin requires Python version 3.10 or above, as well as PennyLane\nand Cirq. Installation of this plugin, as well as all dependencies, can be done using ``pip``:\n\n.. code-block:: bash\n\n $ pip install pennylane-cirq\n\nAlternatively, you can install PennyLane-Cirq from the `source code <https://github.com/PennyLaneAI/pennylane-cirq>`__\nby navigating to the top directory and running:\n\n.. code-block:: bash\n\n $ python setup.py install\n\nDependencies\n~~~~~~~~~~~~\n\nPennyLane-Cirq requires the following libraries be installed:\n\n* `Python <http://python.org/>`__ >= 3.10\n\nas well as the following Python packages:\n\n* `PennyLane <http://pennylane.readthedocs.io/>`__ >= 0.29\n* `Cirq <https://cirq.readthedocs.io/>`__ >= 0.10.0\n\nTo use the qsim and qsimh devices, the qsim-Cirq interface ``qsimcirq`` is required:\n\n* `qsimcirq <https://github.com/quantumlib/qsim/blob/master/docs/cirq_interface.md>`__\n\nIt can be installed using ``pip``:\n\n.. code-block:: bash\n\n $ pip install qsimcirq\n\nIf you currently do not have Python 3 installed, we recommend\n`Anaconda for Python 3 <https://www.anaconda.com/download/>`__, a distributed version of Python packaged\nfor scientific computation.\n\n\nTests\n~~~~~\n\nTo test that the PennyLane-Cirq plugin is working correctly you can run\n\n.. code-block:: bash\n\n $ make test\n\nin the source folder.\n\nDocumentation\n~~~~~~~~~~~~~\n\nTo build the HTML documentation, go to the top-level directory and run:\n\n.. code-block:: bash\n\n $ make docs\n\n\nThe documentation can then be found in the ``doc/_build/html/`` directory.\n\n.. installation-end-inclusion-marker-do-not-remove\n\nContributing\n============\n\nWe welcome contributions - simply fork the repository of this plugin, and then make a\n`pull request <https://help.github.com/articles/about-pull-requests/>`__ containing your contribution.\nAll contributers to this plugin will be listed as authors on the releases.\n\nWe also encourage bug reports, suggestions for new features and enhancements, and even links to cool projects\nor applications built on PennyLane.\n\nAuthors\n=======\n\nPennyLane-Cirq is the work of `many contributors <https://github.com/PennyLaneAI/pennylane-cirq/graphs/contributors>`__.\n\nIf you are doing research using PennyLane and PennyLane-Cirq, please cite `our paper <https://arxiv.org/abs/1811.04968>`__:\n\n Ville Bergholm, Josh Izaac, Maria Schuld, Christian Gogolin, M. Sohaib Alam, Shahnawaz Ahmed,\n Juan Miguel Arrazola, Carsten Blank, Alain Delgado, Soran Jahangiri, Keri McKiernan, Johannes Jakob Meyer,\n Zeyue Niu, Antal Sz\u00e1va, and Nathan Killoran.\n *PennyLane: Automatic differentiation of hybrid quantum-classical computations.* 2018. arXiv:1811.04968\n\n.. support-start-inclusion-marker-do-not-remove\n\nSupport\n=======\n\n- **Source Code:** https://github.com/PennyLaneAI/pennylane-cirq\n- **Issue Tracker:** https://github.com/PennyLaneAI/pennylane-cirq/issues\n- **PennyLane Forum:** https://discuss.pennylane.ai\n\nIf you are having issues, please let us know by posting the issue on our Github issue tracker, or\nby asking a question in the forum.\n\n.. support-end-inclusion-marker-do-not-remove\n.. license-start-inclusion-marker-do-not-remove\n\nLicense\n=======\n\nThe PennyLane-Cirq plugin is **free** and **open source**, released under\nthe `Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`__.\n\n.. license-end-inclusion-marker-do-not-remove\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "PennyLane plugin for Cirq",
"version": "0.40.0",
"project_urls": {
"Homepage": "http://xanadu.ai"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7d1be7e5e037e883b84ac5ba12e19f6b11b3b37a961d555f5a81c20b1cddaac",
"md5": "2543d0e3b29d0082121b44e7274a92c8",
"sha256": "fecd7e1ac9864efaa5ba4399597418646f71941a513ce311812412a66e450171"
},
"downloads": -1,
"filename": "PennyLane_Cirq-0.40.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2543d0e3b29d0082121b44e7274a92c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21668,
"upload_time": "2025-01-14T22:05:16",
"upload_time_iso_8601": "2025-01-14T22:05:16.558445Z",
"url": "https://files.pythonhosted.org/packages/d7/d1/be7e5e037e883b84ac5ba12e19f6b11b3b37a961d555f5a81c20b1cddaac/PennyLane_Cirq-0.40.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-14 22:05:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pennylane-cirq"
}
JSON