cirq


Namecirq JSON
Version 1.3.0 PyPI version JSON
download
home_pagehttp://github.com/quantumlib/cirq
SummaryA framework for creating, editing, and invoking Noisy Intermediate Scale Quantum (NISQ) circuits.
upload_time2023-12-01 22:11:33
maintainer
docs_urlNone
authorThe Cirq Developers
requires_python>=3.9.0
licenseApache 2
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png
  :target: https://github.com/quantumlib/cirq
  :alt: Cirq
  :width: 500px

Cirq is a Python library for writing, manipulating, and optimizing quantum
circuits and running them against quantum computers and simulators.

.. image:: https://github.com/quantumlib/Cirq/actions/workflows/ci.yml/badge.svg?event=schedule
  :target: https://github.com/quantumlib/Cirq
  :alt: Build Status

.. image:: https://codecov.io/gh/quantumlib/Cirq/branch/main/graph/badge.svg
  :target: https://codecov.io/gh/quantumlib/Cirq

.. image:: https://badge.fury.io/py/cirq.svg
  :target: https://badge.fury.io/py/cirq

.. image:: https://readthedocs.org/projects/cirq/badge/?version=latest
  :target: https://readthedocs.org/projects/cirq/versions/
  :alt: Documentation Status


Installation and Documentation
------------------------------

Cirq documentation is available at `quantumai.google/cirq <https://quantumai.google/cirq>`_.

Documentation for the latest **pre-release** version of cirq (tracks the repository's main branch; what you get if you ``pip install --pre cirq``), is available `here <https://quantumai.google/reference/python/cirq/all_symbols?version=nightly>`__.

Documentation for the latest **stable** version of cirq (what you get if you ``pip install cirq``) is available `here <https://quantumai.google/reference/python/cirq/all_symbols>`__.


- `Installation <https://quantumai.google/cirq/start/install>`_
- `Documentation <https://quantumai.google/cirq>`_
- `Tutorials <https://quantumai.google/cirq/build>`_

For a comprehensive list all of the interactive Jupyter Notebooks in our repo (including the ones not yet published to the site) open our repo in `Colab <https://colab.research.google.com/github/quantumlib/Cirq>`_.

For the latest news regarding Cirq, sign up to the `Cirq-announce email list <https://groups.google.com/forum/#!forum/cirq-announce>`__!


Hello Qubit
-----------

A simple example to get you up and running:

.. code-block:: python

  import cirq

  # Pick a qubit.
  qubit = cirq.GridQubit(0, 0)

  # Create a circuit
  circuit = cirq.Circuit(
      cirq.X(qubit)**0.5,  # Square root of NOT.
      cirq.measure(qubit, key='m')  # Measurement.
  )
  print("Circuit:")
  print(circuit)

  # Simulate the circuit several times.
  simulator = cirq.Simulator()
  result = simulator.run(circuit, repetitions=20)
  print("Results:")
  print(result)

Example output:

.. code-block::

  Circuit:
  (0, 0): ───X^0.5───M('m')───
  Results:
  m=11000111111011001000


Feature requests / Bugs / Questions
-----------------------------------

If you have feature requests or you found a bug, please `file them on Github <https://github.com/quantumlib/Cirq/issues/new/choose>`__.

For questions about how to use Cirq post to
`Quantum Computing Stack Exchange <https://quantumcomputing.stackexchange.com/>`__ with the
`cirq <https://quantumcomputing.stackexchange.com/questions/tagged/cirq>`__ tag.

How to cite Cirq
----------------

Cirq is uploaded to Zenodo automatically. Click on the badge below to see all the citation formats for all versions.

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4062499.svg
  :target: https://doi.org/10.5281/zenodo.4062499
  :alt: DOI

Cirq Contributors Community
---------------------------

We welcome contributions! Before opening your first PR, a good place to start is to read our
`guidelines <https://github.com/quantumlib/cirq/blob/main/CONTRIBUTING.md>`__.

We are dedicated to cultivating an open and inclusive community to build software for near term quantum computers.
Please read our `code of conduct <https://github.com/quantumlib/cirq/blob/main/CODE_OF_CONDUCT.md>`__ for the rules of engagement within our community.

For real time informal discussions about Cirq, join our `cirqdev <https://gitter.im/cirqdev/community>`__ Gitter channel, come hangout with us!

**Cirq Cynque** is our weekly meeting for contributors to discuss upcoming features, designs, issues, community and status of different efforts.
To get an invitation please join the `cirq-dev email list <https://groups.google.com/forum/#!forum/cirq-dev>`__ which also serves as yet another platform to discuss contributions and design ideas.


See Also
--------

For those interested in using quantum computers to solve problems in
chemistry and materials science, we encourage exploring
`OpenFermion <https://github.com/quantumlib/openfermion>`__ and
its sister library for compiling quantum simulation algorithms in Cirq,
`OpenFermion-Cirq <https://github.com/quantumlib/openfermion-cirq>`__.

For machine learning enthusiasts, `Tensorflow Quantum <https://github.com/tensorflow/quantum>`__ is a great project to check out!

For a powerful quantum circuit simulator that integrates well with Cirq, we recommend looking at `qsim <https://github.com/quantumlib/qsim>`__.

Finally, `ReCirq <https://github.com/quantumlib/ReCirq>`__ contains real world experiments using Cirq.

Cirq is not an official Google product. Copyright 2019 The Cirq Developers

            

Raw data

            {
    "_id": null,
    "home_page": "http://github.com/quantumlib/cirq",
    "name": "cirq",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "The Cirq Developers",
    "author_email": "cirq-dev@googlegroups.com",
    "download_url": "",
    "platform": null,
    "description": ".. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png\n  :target: https://github.com/quantumlib/cirq\n  :alt: Cirq\n  :width: 500px\n\nCirq is a Python library for writing, manipulating, and optimizing quantum\ncircuits and running them against quantum computers and simulators.\n\n.. image:: https://github.com/quantumlib/Cirq/actions/workflows/ci.yml/badge.svg?event=schedule\n  :target: https://github.com/quantumlib/Cirq\n  :alt: Build Status\n\n.. image:: https://codecov.io/gh/quantumlib/Cirq/branch/main/graph/badge.svg\n  :target: https://codecov.io/gh/quantumlib/Cirq\n\n.. image:: https://badge.fury.io/py/cirq.svg\n  :target: https://badge.fury.io/py/cirq\n\n.. image:: https://readthedocs.org/projects/cirq/badge/?version=latest\n  :target: https://readthedocs.org/projects/cirq/versions/\n  :alt: Documentation Status\n\n\nInstallation and Documentation\n------------------------------\n\nCirq documentation is available at `quantumai.google/cirq <https://quantumai.google/cirq>`_.\n\nDocumentation for the latest **pre-release** version of cirq (tracks the repository's main branch; what you get if you ``pip install --pre cirq``), is available `here <https://quantumai.google/reference/python/cirq/all_symbols?version=nightly>`__.\n\nDocumentation for the latest **stable** version of cirq (what you get if you ``pip install cirq``) is available `here <https://quantumai.google/reference/python/cirq/all_symbols>`__.\n\n\n- `Installation <https://quantumai.google/cirq/start/install>`_\n- `Documentation <https://quantumai.google/cirq>`_\n- `Tutorials <https://quantumai.google/cirq/build>`_\n\nFor a comprehensive list all of the interactive Jupyter Notebooks in our repo (including the ones not yet published to the site) open our repo in `Colab <https://colab.research.google.com/github/quantumlib/Cirq>`_.\n\nFor the latest news regarding Cirq, sign up to the `Cirq-announce email list <https://groups.google.com/forum/#!forum/cirq-announce>`__!\n\n\nHello Qubit\n-----------\n\nA simple example to get you up and running:\n\n.. code-block:: python\n\n  import cirq\n\n  # Pick a qubit.\n  qubit = cirq.GridQubit(0, 0)\n\n  # Create a circuit\n  circuit = cirq.Circuit(\n      cirq.X(qubit)**0.5,  # Square root of NOT.\n      cirq.measure(qubit, key='m')  # Measurement.\n  )\n  print(\"Circuit:\")\n  print(circuit)\n\n  # Simulate the circuit several times.\n  simulator = cirq.Simulator()\n  result = simulator.run(circuit, repetitions=20)\n  print(\"Results:\")\n  print(result)\n\nExample output:\n\n.. code-block::\n\n  Circuit:\n  (0, 0): \u2500\u2500\u2500X^0.5\u2500\u2500\u2500M('m')\u2500\u2500\u2500\n  Results:\n  m=11000111111011001000\n\n\nFeature requests / Bugs / Questions\n-----------------------------------\n\nIf you have feature requests or you found a bug, please `file them on Github <https://github.com/quantumlib/Cirq/issues/new/choose>`__.\n\nFor questions about how to use Cirq post to\n`Quantum Computing Stack Exchange <https://quantumcomputing.stackexchange.com/>`__ with the\n`cirq <https://quantumcomputing.stackexchange.com/questions/tagged/cirq>`__ tag.\n\nHow to cite Cirq\n----------------\n\nCirq is uploaded to Zenodo automatically. Click on the badge below to see all the citation formats for all versions.\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4062499.svg\n  :target: https://doi.org/10.5281/zenodo.4062499\n  :alt: DOI\n\nCirq Contributors Community\n---------------------------\n\nWe welcome contributions! Before opening your first PR, a good place to start is to read our\n`guidelines <https://github.com/quantumlib/cirq/blob/main/CONTRIBUTING.md>`__.\n\nWe are dedicated to cultivating an open and inclusive community to build software for near term quantum computers.\nPlease read our `code of conduct <https://github.com/quantumlib/cirq/blob/main/CODE_OF_CONDUCT.md>`__ for the rules of engagement within our community.\n\nFor real time informal discussions about Cirq, join our `cirqdev <https://gitter.im/cirqdev/community>`__ Gitter channel, come hangout with us!\n\n**Cirq Cynque** is our weekly meeting for contributors to discuss upcoming features, designs, issues, community and status of different efforts.\nTo get an invitation please join the `cirq-dev email list <https://groups.google.com/forum/#!forum/cirq-dev>`__ which also serves as yet another platform to discuss contributions and design ideas.\n\n\nSee Also\n--------\n\nFor those interested in using quantum computers to solve problems in\nchemistry and materials science, we encourage exploring\n`OpenFermion <https://github.com/quantumlib/openfermion>`__ and\nits sister library for compiling quantum simulation algorithms in Cirq,\n`OpenFermion-Cirq <https://github.com/quantumlib/openfermion-cirq>`__.\n\nFor machine learning enthusiasts, `Tensorflow Quantum <https://github.com/tensorflow/quantum>`__ is a great project to check out!\n\nFor a powerful quantum circuit simulator that integrates well with Cirq, we recommend looking at `qsim <https://github.com/quantumlib/qsim>`__.\n\nFinally, `ReCirq <https://github.com/quantumlib/ReCirq>`__ contains real world experiments using Cirq.\n\nCirq is not an official Google product. Copyright 2019 The Cirq Developers\n",
    "bugtrack_url": null,
    "license": "Apache 2",
    "summary": "A framework for creating, editing, and invoking Noisy Intermediate Scale Quantum (NISQ) circuits.",
    "version": "1.3.0",
    "project_urls": {
        "Homepage": "http://github.com/quantumlib/cirq"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3dae539163c3f38f1d074a6395f653f7da9b86ae09a4181c4c9f0dc2e9a80ff8",
                "md5": "87a9cb690bb51f743904edd16c3b220e",
                "sha256": "9e39f2c919864ee3f6a4b4b1dcfdaacb4d5e753e2c7fc7ebb0a93947d6cefcab"
            },
            "downloads": -1,
            "filename": "cirq-1.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "87a9cb690bb51f743904edd16c3b220e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9.0",
            "size": 8069,
            "upload_time": "2023-12-01T22:11:33",
            "upload_time_iso_8601": "2023-12-01T22:11:33.443320Z",
            "url": "https://files.pythonhosted.org/packages/3d/ae/539163c3f38f1d074a6395f653f7da9b86ae09a4181c4c9f0dc2e9a80ff8/cirq-1.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-01 22:11:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "quantumlib",
    "github_project": "cirq",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cirq"
}
        
Elapsed time: 0.22275s