quantumlib · pavoljuhas · Feb 1, 2025 · Dec 30, 2024 · Dec 31, 2024 · Jan 7, 2025
@@ -1,27 +1,82 @@
-.. image:: https://www.aqt.eu/wp-content/uploads/2018/08/Logo-Alpine-Quantum-Technologies-AQT-1.png
-  :target: https://github.com/quantumlib/cirq/
-  :alt: cirq-aqt
-  :width: 200px
+.. |cirqlogo| image:: https://raw.githubusercontent.com/quantumlib/Cirq/refs/heads/main/docs/images/Cirq_logo_color.svg
+   :alt: Cirq logo
+   :target: https://github.com/quantumlib/cirq
+   :width: 190px
 
-`Cirq <https://quantumai.google/cirq>`__ is a Python library for writing, manipulating, and optimizing quantum
-circuits and running them against quantum computers and simulators.
+.. |aqtlogo| image:: https://www.aqt.eu/wp-content/uploads/2024/01/Logo-AQT-Alpine-Quantum-Technologies-2.png
+   :alt: AQT logo
+   :target: https://www.aqt.eu
+   :width: 200px
 
-This module is **cirq-aqt**, which provides everything you'll need to run Cirq quantum algorithms on AQT quantum computers.
+.. |cirq| replace:: Cirq
+.. _cirq: https://github.com/quantumlib/cirq
 
-Documentation
--------------
+.. |cirq-docs| replace:: Cirq documentation site
+.. _cirq-docs: https://quantumai.google/cirq
+
+.. |cirq-github| replace:: Cirq GitHub repository
+.. _cirq-github: https://github.com/quantumlib/Cirq
+
+.. |cirq-aqt| replace:: ``cirq-aqt``
+.. |cirq-core| replace:: ``cirq-core``
+
+.. class:: centered
+.. Note: the space between the following items uses no-break spaces.
 
-To get started with the Alpine Quantum Technologies, checkout the following guide and tutorial:
+|cirqlogo|            |aqtlogo|
+
+This Python module is |cirq-aqt|, which provides everything you'll need to run
+|cirq|_ quantum algorithms on quantum computers made by `Alpine Quantum
+Technologies GmbH <https://www.aqt.eu>`__.
+
+|cirq|_ is a Python package for writing, manipulating, and running `quantum
+circuits <https://en.wikipedia.org/wiki/Quantum_circuit>`__ on quantum
+computers and simulators. Cirq provides useful abstractions for dealing with
+today’s `noisy intermediate-scale quantum <https://arxiv.org/abs/1801.00862>`__
+(NISQ) computers, where the details of quantum hardware are vital to achieving
+state-of-the-art results. For more information about Cirq, please visit the
+|cirq-docs|_.
 
-- `Access and authentication <https://quantumai.google/cirq/aqt/access>`__
-- `Getting started guide <https://quantumai.google/cirq/tutorials/aqt/getting_started>`__
 
 Installation
 ------------
 
-To install the stable version of only **cirq-aqt**, use `pip install cirq-aqt`.
-To install the pre-release version of only **cirq-aqt**, use `pip install cirq-aqt~=1.0.dev`.
+This module is built on top of |cirq|_; installing this module will
+automatically install |cirq-core| and other dependencies. There are two
+installation options for the |cirq-aqt| module:
+
+* To install the stable version of |cirq-aqt|, use ``pip install cirq-aqt``.
+
+* To install the latest pre-release version of |cirq-aqt|, use ``pip install
+  cirq-aqt~=1.0.dev``. (The ``~=`` has a special meaning to ``pip`` of
+  selecting the latest version compatible with the ``1.*`` and ``dev`` in the
+  name. Despite appearances, this will not install an old version 1.0 release!)
+
+If you would like to install Cirq with all the optional modules, not just
+|cirq-aqt|, then instead of the above commands, use ``pip install cirq`` for
+the stable release or ``pip install cirq~=1.0.dev`` for the latest pre-release
+version.
+
+
+Documentation
+-------------
+
+To get started with using AQT quantum computers through Cirq, please refer to
+the following documentation:
+
+* `Access and authentication <https://quantumai.google/cirq/aqt/access>`__
+
+* `Getting started guide
+  <https://quantumai.google/cirq/tutorials/aqt/getting_started>`__
+
+To get started with using Cirq in general, please refer to the |cirq-docs|_.
+
+For more information about getting help, reporting bugs, and other matters
+related to Cirq and the Cirq-AQT integration module, please visit the
+|cirq-github|_.
+
 
-Note, that this will install both cirq-aqt and cirq-core as well.
+Disclaimer
+----------
 
-To get all the optional modules installed as well, you'll have to use `pip install cirq` or `pip install cirq~=1.0.dev` for the pre-release version.
+Cirq is not an official Google product. Copyright 2019 The Cirq Developers
@@ -1,18 +1,71 @@
-.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png
-  :target: https://github.com/quantumlib/cirq
-  :alt: Cirq
-  :width: 500px
+.. |cirqlogo| image:: https://raw.githubusercontent.com/quantumlib/Cirq/refs/heads/main/docs/images/Cirq_logo_color.svg
+   :alt: Cirq logo
+   :target: https://github.com/quantumlib/cirq
+   :height: 100px
 
-Cirq is a Python library for writing, manipulating, and optimizing quantum
-circuits and running them against quantum computers and simulators.
+.. |cirq| replace:: Cirq
+.. _cirq: https://github.com/quantumlib/cirq
+
+.. |cirq-docs| replace:: Cirq documentation site
+.. _cirq-docs: https://quantumai.google/cirq
+
+.. |cirq-github| replace:: Cirq GitHub repository
+.. _cirq-github: https://github.com/quantumlib/Cirq
+
+.. |cirq-core| replace:: ``cirq-core``
+
+.. class:: centered
+
+|cirqlogo|
+
+|cirq|_ is a Python package for writing, manipulating, and running `quantum
+circuits <https://en.wikipedia.org/wiki/Quantum_circuit>`__ on quantum
+computers and simulators. Cirq provides useful abstractions for dealing with
+today’s `noisy intermediate-scale quantum <https://arxiv.org/abs/1801.00862>`__
+(NISQ) computers, where the details of quantum hardware are vital to achieving
+state-of-the-art results. For more information about Cirq, please visit the
+|cirq-docs|_.
+
+This Python module is |cirq-core|, which contains everything you'd need to
+write quantum algorithms for NISQ devices and run them on the built-in Cirq
+simulators.
+
+To run algorithms on a given quantum computing platform, you will also need to
+install an appropriate Cirq hardware interface module. Please visit `the
+hardware section of the Cirq documentation site
+<https://quantumai.google/cirq/hardware>`_ for information about the hardware
+interface modules currently available.
 
-This module is **cirq-core**, which contains everything you'd need to write quantum algorithms for NISQ devices and run them on the built-in Cirq simulators.
-In order to run algorithms on a given quantum hardware platform, you'll have to install the right cirq module as well.
 
 Installation
 ------------
 
-To install the stable version of only **cirq-core**, use `pip install cirq-core`.
-To install the pre-release version of only **cirq-core**, use `pip install cirq-core~=1.0.dev`.
+There are two installation options for the |cirq-core| module:
+
+* To install the stable version of |cirq-core|, use ``pip install cirq-core``.
+
+* To install the pre-release version of |cirq-core|, use ``pip install
+  cirq-core~=1.0.dev``. (The ``~=`` has a special meaning to ``pip`` of
+  selecting the latest version compatible with the ``1.*`` and ``dev`` in the
+  name. Despite appearances, this will not install an old version 1.0 release!)
+
+If you would like to install Cirq with all the optional modules, not just
+|cirq-core|, then instead of the above commands, use ``pip install cirq`` for
+the stable release or ``pip install cirq~=1.0.dev`` for the latest pre-release
+version.
+
+
+Documentation
+-------------
+
+To get started with using Cirq, please refer to the |cirq-docs|_.
+
+For more information about getting help, reporting bugs, and other matters
+related to Cirq and the Cirq-Core integration module, please visit the
+|cirq-github|_.
+
+
+Disclaimer
+----------
 
-To get all the optional modules installed as well, you'll have to use `pip install cirq` or `pip install cirq~=1.0.dev` for the pre-release version.
+Cirq is not an official Google product. Copyright 2019 The Cirq Developers
@@ -1,30 +1,92 @@
-.. image:: https://quantumai.google/site-assets/images/marketing/icons/ic-qcs.png
-  :target: https://github.com/quantumlib/cirq/
-  :alt: cirq-google
-  :width: 500px
+.. |cirqlogo| image:: https://raw.githubusercontent.com/quantumlib/Cirq/refs/heads/main/docs/images/Cirq_logo_color.svg
+   :alt: Cirq logo
+   :target: https://github.com/quantumlib/cirq
+   :height: 80px
 
-`Cirq <https://quantumai.google/cirq>`__ is a Python library for writing, manipulating, and optimizing quantum
-circuits and running them against quantum computers and simulators.
+.. |qailogo| image:: https://quantumai.google/static/site-assets/images/marketing/favicon.png
+   :alt: Google logo
+   :target: https://quantumai.google/
+   :height: 80px
 
-This module is **cirq-google**, which provides everything you'll need to run Cirq quantum algorithms on the Google Quantum Computing Service.
-It also contains additional tools for calibration and characterization of the Google quantum devices.
+.. |cirq| replace:: Cirq
+.. _cirq: https://github.com/quantumlib/cirq
 
-Documentation
--------------
+.. |cirq-docs| replace:: Cirq documentation site
+.. _cirq-docs: https://quantumai.google/cirq
+
+.. |cirq-github| replace:: Cirq GitHub repository
+.. _cirq-github: https://github.com/quantumlib/Cirq
+
+.. |cirq-google| replace:: ``cirq-google``
+.. |cirq-core| replace:: ``cirq-core``
+
+.. class:: centered
+.. Note: the space between the following items uses no-break spaces.
+
+|cirqlogo|                  |qailogo|
 
-Access to Google Hardware is currently restricted to those in an approved group. In order to do this, you will need to apply for access, typically in partnership with a Google sponsor.
+This Python module is |cirq-google|. It provides an interface to Google's
+`Quantum Computing Service <https://quantumai.google/cirq/google/concepts>`__,
+and also contains additional tools for calibration and characterization of
+Google's quantum hardware devices.
+
++----------------------------------------------------------------------+
+| Please note                                                          |
++======================================================================+
+|*Access to Google quantum hardware is currently restricted to         |
+|authorized partners only. In order to use the devices, you will need  |
+|to apply for access, typically in partnership with a Google sponsor.* |
++----------------------------------------------------------------------+
+
+|cirq|_ is a Python package for writing, manipulating, and running `quantum
+circuits <https://en.wikipedia.org/wiki/Quantum_circuit>`__ on quantum
+computers and simulators. Cirq provides useful abstractions for dealing with
+today’s `noisy intermediate-scale quantum <https://arxiv.org/abs/1801.00862>`__
+(NISQ) computers, where the details of quantum hardware are vital to achieving
+state-of-the-art results. For more information about Cirq, please visit the
+|cirq-docs|_.
 
-To get started with the Quantum Computing Service, checkout the following guide and tutorial:
 
-- `Access and authentication <https://quantumai.google/cirq/google/access>`__
-- `Getting started guide <https://quantumai.google/cirq/tutorials/google/start>`__
 
 Installation
 ------------
 
-To install the stable version of only **cirq-google**, use `pip install cirq-google`.
-To install the pre-release version of only **cirq-google**, use `pip install cirq-google~=1.0.dev`.
+This module is built on top of |cirq|_; installing this module will
+automatically install |cirq-core| and other dependencies. There are two
+installation options for the |cirq-google| module:
+
+* To install the stable version of |cirq-google|, use ``pip install cirq-google``.
+
+* To install the pre-release version of |cirq-google|, use ``pip install
+  cirq-google~=1.0.dev``. (The ``~=`` has a special meaning to ``pip`` of
+  selecting the latest version compatible with the ``1.*`` and ``dev`` in the
+  name. Despite appearances, this will not install an old version 1.0 release!)
+
+If you would like to install Cirq with all the optional modules, not just
+|cirq-google|, then instead of the above commands, use ``pip install cirq`` for
+the stable release or ``pip install cirq~=1.0.dev`` for the latest pre-release
+version.
+
+
+Documentation
+-------------
+
+To get started with using Google quantum computers through Cirq, please refer to
+the following documentation:
+
+* `Access and authentication <https://quantumai.google/cirq/google/access>`__
+
+* `Getting started guide
+  <https://quantumai.google/cirq/tutorials/google/start>`__
+
+To get started with using Cirq in general, please refer to the |cirq-docs|_.
+
+For more information about getting help, reporting bugs, and other matters
+related to Cirq and the Cirq-Google integration module, please visit the
+|cirq-github|_.
+
 
-Note, that this will install both cirq-google and cirq-core as well.
+Disclaimer
+----------
 
-To get all the optional modules installed as well, you'll have to use `pip install cirq` or `pip install cirq~=1.0.dev` for the pre-release version.
+Cirq is not an official Google product. Copyright 2019 The Cirq Developers
@@ -1,27 +1,82 @@
-.. image:: https://upload.wikimedia.org/wikipedia/en/thumb/d/d4/IonQ_corp_logo.svg/2560px-IonQ_corp_logo.svg.png
-  :target: https://github.com/quantumlib/cirq/
-  :alt: cirq-ionq
-  :width: 500px
+.. |cirqlogo| image:: https://raw.githubusercontent.com/quantumlib/Cirq/refs/heads/main/docs/images/Cirq_logo_color.svg
+   :alt: Cirq logo
+   :target: https://github.com/quantumlib/cirq
+   :height: 80px
 
-`Cirq <https://quantumai.google/cirq>`__ is a Python library for writing, manipulating, and optimizing quantum
-circuits and running them against quantum computers and simulators.
+.. |ionqlogo| image:: https://ionq.com/images/ionq-logo-dark.svg
+   :alt: IonQ logo
+   :target: https://ionq.com/
+   :height: 80px
 
-This module is **cirq-ionq**, which provides everything you'll need to run Cirq quantum algorithms on IonQ quantum computers.
+.. |cirq| replace:: Cirq
+.. _cirq: https://github.com/quantumlib/cirq
 
-Documentation
--------------
+.. |cirq-docs| replace:: Cirq documentation site
+.. _cirq-docs: https://quantumai.google/cirq
+
+.. |cirq-github| replace:: Cirq GitHub repository
+.. _cirq-github: https://github.com/quantumlib/Cirq
+
+.. |cirq-ionq| replace:: ``cirq-ionq``
+.. |cirq-core| replace:: ``cirq-core``
+
+.. class:: centered
+.. Note: the space between the following items uses no-break spaces.
 
-To get started with IonQ quantum computing services, checkout the following guide and tutorial:
+|cirqlogo|            |ionqlogo|
+
+This Python module is |cirq-ionq|, which provides everything you'll need to run
+|cirq|_ quantum algorithms on quantum computers made by `IonQ, Inc.
+<https://ionq.com/>`__.
+
+|cirq|_ is a Python package for writing, manipulating, and running `quantum
+circuits <https://en.wikipedia.org/wiki/Quantum_circuit>`__ on quantum
+computers and simulators. Cirq provides useful abstractions for dealing with
+today’s `noisy intermediate-scale quantum <https://arxiv.org/abs/1801.00862>`__
+(NISQ) computers, where the details of quantum hardware are vital to achieving
+state-of-the-art results. For more information about Cirq, please visit the
+|cirq-docs|_.
 
-- `Access and authentication <https://quantumai.google/cirq/ionq/access>`__
-- `Getting started guide <https://quantumai.google/cirq/tutorials/ionq/getting_started>`__
 
 Installation
 ------------
 
-To install the stable version of only **cirq-ionq**, use `pip install cirq-ionq`.
-To install the pre-release version of only **cirq-ionq**, use `pip install cirq-ionq~=1.0.dev`.
+This module is built on top of |cirq|_; installing this module will
+automatically install |cirq-core| and other dependencies. There are two
+installation options for the |cirq-ionq| module:
+
+* To install the stable version of |cirq-ionq|, use ``pip install cirq-ionq``.
+
+* To install the pre-release version of |cirq-ionq|, use ``pip install
+  cirq-ionq~=1.0.dev``. (The ``~=`` has a special meaning to ``pip`` of
+  selecting the latest version compatible with the ``1.*`` and ``dev`` in the
+  name. Despite appearances, this will not install an old version 1.0 release!)
+
+If you would like to install Cirq with all the optional modules, not just
+|cirq-ionq|, then instead of the above commands, use ``pip install cirq`` for
+the stable release or ``pip install cirq~=1.0.dev`` for the latest pre-release
+version.
+
+
+Documentation
+-------------
+
+To get started with using IonQ quantum computers through Cirq, please refer to
+the following documentation:
+
+* `Access and authentication <https://quantumai.google/cirq/ionq/access>`__
+
+* `Getting started guide
+  <https://quantumai.google/cirq/tutorials/ionq/getting_started>`__
+
+To get started with using Cirq in general, please refer to the |cirq-docs|_.
+
+For more information about getting help, reporting bugs, and other matters
+related to Cirq and the Cirq-IonQ integration module, please visit the
+|cirq-github|_.
+
 
-Note, that this will install both **cirq-ionq** and **cirq-core**.
+Disclaimer
+----------
 
-To get all the optional modules installed, you'll have to use `pip install cirq` or `pip install cirq~=1.0.dev` for the pre-release version.
+Cirq is not an official Google product. Copyright 2019 The Cirq Developers