Skip to content

Commit 6b2f4d7

Browse files
mhuckamhucka
authored
Update and refresh cirq-* module README files (#6900)
* Update and refresh cirq-* module README files This updates all the cirq-* module files to fix some broken image links, spiff up the layout and formatting, and add some additional links here and there. * Remove unused hyperlink target definition rstcheck complains about it. * Clarify the access restrictions to the quantum computing service * Update & refresh cirq-*/README files & convert to md This updates all the cirq-* module files to fix some broken image links, spiff up the layout and formatting, and add some additional links here and there. As before, these remain purposefully short and fairly minimal because these are add-only modules to the main `cirq` distribution. * Update setup.py's for README.md & refreshed version warning This matches the changes in the top-level `setup.py` file, to adapt them to use README.md instead of README.rst. * Revise intro paragraphs and do misc. fix-ups This updates the text about module purpose and access, and does miscellaneous fixes such as conforming to Google's Markdown style guidance. * Remove "Google QAI" logo It turns out that particular logo is strictly for use only on the QAI website. I want to find another, but right now that doesn't seem to be the best use of time, so let's just use only the Cirq logo and leave it for now. * Fix incorrect links for access and getting started Reported by @Pavol in review comment #6900 (comment) * Remove circled "i" symbol Per request by @Pavol in comment #6900 (comment)
1 parent 0884da7 commit 6b2f4d7

File tree

21 files changed

+584
-251
lines changed

21 files changed

+584
-251
lines changed

‎cirq-aqt/README.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<div align="center">
2+
<img width="190px" alt="Cirq logo"
3+
src="https://raw.githubusercontent.com/quantumlib/Cirq/refs/heads/main/docs/images/Cirq_logo_color.svg"
4+
><img width="60px" height="0" alt=""><img width="200px" alt="AQT logo"
5+
src="https://www.aqt.eu/wp-content/uploads/2024/01/Logo-AQT-Alpine-Quantum-Technologies-2.png">
6+
</div>
7+
8+
# cirq-aqt
9+
10+
This is the Cirq-AQT integration module. It provides an interface that allows
11+
[Cirq] quantum algorithms to run on quantum computers made by [Alpine Quantum
12+
Technologies GmbH](https://www.aqt.eu). (See the [Documentation](#documentation)
13+
section below for information about getting access to AQT devices.)
14+
15+
[Cirq] is a Python package for writing, manipulating, and running [quantum
16+
circuits](https://en.wikipedia.org/wiki/Quantum_circuit) on quantum computers
17+
and simulators. Cirq provides useful abstractions for dealing with today’s
18+
[noisy intermediate-scale quantum](https://arxiv.org/abs/1801.00862) (NISQ)
19+
computers, where the details of quantum hardware are vital to achieving
20+
state-of-the-art results. For more information about Cirq, please visit the
21+
[Cirq documentation site].
22+
23+
[Cirq]: https://github.com/quantumlib/cirq
24+
[Cirq documentation site]: https://quantumai.google/cirq
25+
26+
## Installation
27+
28+
This module is built on top of [Cirq]; installing this module will
29+
automatically install the `cirq-core` module and other dependencies. There are
30+
two installation options for the `cirq-aqt` module:
31+
32+
* To install the stable version of `cirq-aqt`, use
33+
34+
```shell
35+
pip install cirq-aqt
36+
```
37+
38+
* To install the latest pre-release version of `cirq-aqt`, use
39+
40+
```shell
41+
pip install cirq-aqt~=1.0.dev
42+
```
43+
44+
(The `~=` has a special meaning to `pip` of selecting the latest version
45+
compatible with the `1.*` and `dev` in the name. Despite appearances,
46+
this will not install an old version 1.0 release!)
47+
48+
If you would like to install Cirq with all the optional modules, not just
49+
`cirq-aqt`, then instead of the above commands, use `pip install cirq` for the
50+
stable release or `pip install cirq~=1.0.dev` for the latest pre-release
51+
version.
52+
53+
## Documentation
54+
55+
To get started with using AQT quantum computers through Cirq, please refer to
56+
the following documentation:
57+
58+
* [Access and authentication](https://quantumai.google/cirq/aqt/access).
59+
* [Getting started
60+
guide](https://quantumai.google/cirq/tutorials/aqt/getting_started).
61+
62+
To get started with using Cirq in general, please refer to the [Cirq
63+
documentation site].
64+
65+
For more information about getting help, reporting bugs, and other matters
66+
related to Cirq and the Cirq-AQT integration module, please visit the [Cirq
67+
repository on GitHub](https://github.com/quantumlib/Cirq).
68+
69+
## Disclaimer
70+
71+
Cirq is not an official Google product. Copyright 2019 The Cirq Developers.

‎cirq-aqt/README.rst‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎cirq-aqt/setup.py‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
)
2828

2929
# README file as long_description.
30-
long_description = io.open('README.rst', encoding='utf-8').read()
30+
long_description = io.open('README.md', encoding='utf-8').read()
3131

3232
# If CIRQ_PRE_RELEASE_VERSION is set then we update the version to this value.
3333
# It is assumed that it ends with one of `.devN`, `.aN`, `.bN`, `.rcN` and hence
@@ -37,9 +37,13 @@
3737
if 'CIRQ_PRE_RELEASE_VERSION' in os.environ:
3838
__version__ = os.environ['CIRQ_PRE_RELEASE_VERSION']
3939
long_description = (
40-
"**This is a development version of Cirq-AQT and may be "
41-
"unstable.**\n\n**For the latest stable release of Cirq-AQT "
42-
"see**\n`here <https://pypi.org/project/cirq-aqt>`__.\n\n" + long_description
40+
"<div align='center' width='50%'>\n\n"
41+
"| ⚠️ WARNING |\n"
42+
"|:----------:|\n"
43+
"| **This is a development version of `cirq-aqt` and may be<br>"
44+
"unstable. For the latest stable release of `cirq-aqt`,<br>"
45+
"please visit** <https://pypi.org/project/cirq-aqt>.|\n"
46+
"\n</div>\n\n" + long_description
4347
)
4448

4549
# Read in requirements

‎cirq-core/README.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
<div align="center">
2+
<img width="220px" alt="Cirq logo"
3+
src="https://raw.githubusercontent.com/quantumlib/Cirq/refs/heads/main/docs/images/Cirq_logo_color.svg">
4+
</div>
5+
6+
# cirq-core
7+
8+
[Cirq] is a Python package for writing, manipulating, and running [quantum
9+
circuits](https://en.wikipedia.org/wiki/Quantum_circuit) on quantum computers
10+
and simulators. Cirq provides useful abstractions for dealing with today’s
11+
[noisy intermediate-scale quantum](https://arxiv.org/abs/1801.00862) (NISQ)
12+
computers, where the details of quantum hardware are vital to achieving
13+
state-of-the-art results. For more information about Cirq, please visit the
14+
[Cirq documentation site].
15+
16+
This Python module is `cirq-core`, which contains all the code you need to
17+
write quantum algorithms for NISQ devices and run them on the built-in Cirq
18+
simulators.
19+
20+
To run algorithms on a given quantum computing platform, you will also need to
21+
install an appropriate Cirq hardware interface module. Please visit the
22+
[hardware section of the Cirq documentation
23+
site](https://quantumai.google/cirq/hardware) for information about the
24+
hardware interface modules currently available.
25+
26+
[Cirq]: https://github.com/quantumlib/cirq
27+
[Cirq documentation site]: https://quantumai.google/cirq
28+
29+
## Installation
30+
31+
There are two installation options for the `cirq-core` module:
32+
33+
* To install the stable version of `cirq-core`, use
34+
35+
```shell
36+
pip install cirq-core
37+
```
38+
39+
* To install the latest pre-release version of `cirq-core`, use
40+
41+
```shell
42+
pip install cirq-core~=1.0.dev
43+
```
44+
45+
(The `~=` has a special meaning to `pip` of selecting the latest version
46+
compatible with the `1.*` and `dev` in the name. Despite appearances,
47+
this will not install an old version 1.0 release!)
48+
49+
If you would like to install Cirq with all the optional modules, not just
50+
`cirq-core`, then instead of the above commands, use `pip install cirq` for the
51+
stable release or `pip install cirq~=1.0.dev` for the latest pre-release
52+
version.
53+
54+
## Documentation
55+
56+
To get started with using Cirq, please refer to the [Cirq documentation site].
57+
58+
For more information about getting help, reporting bugs, and other matters
59+
related to Cirq and the Cirq-Core integration module, please visit the [Cirq
60+
repository on GitHub](https://github.com/quantumlib/Cirq).
61+
62+
## Disclaimer
63+
64+
Cirq is not an official Google product. Copyright 2019 The Cirq Developers.

‎cirq-core/README.rst‎

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎cirq-core/setup.py‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
)
2929

3030
# README file as long_description.
31-
long_description = io.open('README.rst', encoding='utf-8').read()
31+
long_description = io.open('README.md', encoding='utf-8').read()
3232

3333
# If CIRQ_PRE_RELEASE_VERSION is set then we update the version to this value.
3434
# It is assumed that it ends with one of `.devN`, `.aN`, `.bN`, `.rcN` and hence
@@ -38,9 +38,13 @@
3838
if 'CIRQ_PRE_RELEASE_VERSION' in os.environ:
3939
__version__ = os.environ['CIRQ_PRE_RELEASE_VERSION']
4040
long_description = (
41-
"**This is a development version of Cirq-core and may be "
42-
"unstable.**\n\n**For the latest stable release of Cirq-core "
43-
"see**\n`here <https://pypi.org/project/cirq-core>`__.\n\n" + long_description
41+
"<div align='center' width='50%'>\n\n"
42+
"| ⚠️ WARNING |\n"
43+
"|:----------:|\n"
44+
"| **This is a development version of `cirq-core` and may be<br>"
45+
"unstable. For the latest stable release of `cirq-core`,<br>"
46+
"please visit** <https://pypi.org/project/cirq-core>.|\n"
47+
"\n</div>\n\n" + long_description
4448
)
4549

4650
# Read in requirements

‎cirq-google/README.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<div align="center">
2+
<img width="220px" alt="Cirq logo"
3+
src="https://raw.githubusercontent.com/quantumlib/Cirq/refs/heads/main/docs/images/Cirq_logo_color.svg">
4+
</div>
5+
6+
# cirq-google
7+
8+
This is the Cirq-Google integration module. It provides an interface to
9+
Google's [Quantum Computing
10+
Service](https://quantumai.google/cirq/google/concepts), and also contains
11+
additional tools for calibration and characterization of Google's quantum
12+
hardware devices.
13+
14+
| Please note! |
15+
|:--------------------:|
16+
| Google's quantum hardware is currently available only to authorized partners. Access requires an application, usually with a Google sponsor.|
17+
18+
[Cirq] is a Python package for writing, manipulating, and running [quantum
19+
circuits](https://en.wikipedia.org/wiki/Quantum_circuit) on quantum computers
20+
and simulators. Cirq provides useful abstractions for dealing with today’s
21+
[noisy intermediate-scale quantum](https://arxiv.org/abs/1801.00862) (NISQ)
22+
computers, where the details of quantum hardware are vital to achieving
23+
state-of-the-art results. For more information about Cirq, please visit the
24+
[Cirq documentation site].
25+
26+
[Cirq]: https://github.com/quantumlib/cirq
27+
[Cirq documentation site]: https://quantumai.google/cirq
28+
29+
## Installation
30+
31+
This module is built on top of [Cirq]; installing this module will
32+
automatically install `cirq-core` and other dependencies. There are two
33+
installation options for the `cirq-google` module:
34+
35+
* To install the stable version of `cirq-google`, use
36+
37+
```shell
38+
pip install cirq-google
39+
```
40+
41+
* To install the latest pre-release version of `cirq-google`, use
42+
43+
```shell
44+
pip install cirq-google~=1.0.dev
45+
```
46+
47+
(The `~=` has a special meaning to `pip` of selecting the latest version
48+
compatible with the `1.*` and `dev` in the name. Despite appearances,
49+
this will not install an old version 1.0 release!)
50+
51+
If you would like to install Cirq with all the optional modules, not just
52+
`cirq-google`, then instead of the above commands, use `pip install cirq` for
53+
the stable release or `pip install cirq~=1.0.dev` for the latest pre-release
54+
version.
55+
56+
## Documentation
57+
58+
To get started with using Google quantum computers through Cirq, please refer to
59+
the following documentation:
60+
61+
* [Access and authentication](https://quantumai.google/cirq/google/access).
62+
* [Getting started
63+
guide](https://quantumai.google/cirq/tutorials/google/start).
64+
65+
To get started with using Cirq in general, please refer to the [Cirq
66+
documentation site].
67+
68+
For more information about getting help, reporting bugs, and other matters
69+
related to Cirq and the Cirq-Core integration module, please visit the [Cirq
70+
repository on GitHub](https://github.com/quantumlib/Cirq).
71+
72+
## Disclaimer
73+
74+
Cirq is not an official Google product. Copyright 2019 The Cirq Developers.

‎cirq-google/README.rst‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎cirq-google/setup.py‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
)
2727

2828
# README file as long_description.
29-
long_description = open('README.rst', encoding='utf-8').read()
29+
long_description = open('README.md', encoding='utf-8').read()
3030

3131
# If CIRQ_PRE_RELEASE_VERSION is set then we update the version to this value.
3232
# It is assumed that it ends with one of `.devN`, `.aN`, `.bN`, `.rcN` and hence
@@ -36,9 +36,13 @@
3636
if 'CIRQ_PRE_RELEASE_VERSION' in os.environ:
3737
__version__ = os.environ['CIRQ_PRE_RELEASE_VERSION']
3838
long_description = (
39-
"**This is a development version of Cirq-google and may be "
40-
"unstable.**\n\n**For the latest stable release of Cirq-google "
41-
"see**\n`here <https://pypi.org/project/cirq-google>`__.\n\n" + long_description
39+
"<div align='center' width='50%'>\n\n"
40+
"| ⚠️ WARNING |\n"
41+
"|:----------:|\n"
42+
"| **This is a development version of `cirq-google` and may be<br>"
43+
"unstable. For the latest stable release of `cirq-google`,<br>"
44+
"please visit** <https://pypi.org/project/cirq-google>.|\n"
45+
"\n</div>\n\n" + long_description
4246
)
4347

4448
# Read in requirements

0 commit comments

Comments
 (0)