Skip to content

Commit 5a479db

Browse files
authored
Install cirq pre-release with stable dependencies (#6534)
Update instructions to use `pip install cirq~=1.0.dev` for cirq pre-release. This matches the latest pre-release with the major version 1. Avoid using the pip-install `--pre` option as it applies to all direct and transitive dependencies that get installed with cirq.
1 parent 2e2ad24 commit 5a479db

32 files changed

+63
-63
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ RUN pip3 install cirq
2323

2424
##cirq pre_release image
2525
FROM cirq_base AS cirq_pre_release
26-
RUN pip3 install cirq --pre
26+
RUN pip3 install cirq~=1.0.dev

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Installation and Documentation
2222

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

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

2727
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>`__.
2828

cirq-aqt/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Installation
2020
------------
2121

2222
To install the stable version of only **cirq-aqt**, use `pip install cirq-aqt`.
23-
To install the pre-release version of only **cirq-aqt**, use `pip install cirq-aqt --pre`.
23+
To install the pre-release version of only **cirq-aqt**, use `pip install cirq-aqt~=1.0.dev`.
2424

2525
Note, that this will install both cirq-aqt and cirq-core as well.
2626

27-
To get all the optional modules installed as well, you'll have to use `pip install cirq` or `pip install cirq --pre` for the pre-release version.
27+
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-core/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ Installation
1313
------------
1414

1515
To install the stable version of only **cirq-core**, use `pip install cirq-core`.
16-
To install the pre-release version of only **cirq-core**, use `pip install cirq-core --pre`.
16+
To install the pre-release version of only **cirq-core**, use `pip install cirq-core~=1.0.dev`.
1717

18-
To get all the optional modules installed as well, you'll have to use `pip install cirq` or `pip install cirq --pre` for the pre-release version.
18+
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-core/cirq/contrib/quimb/Cirq-to-Tensor-Networks.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
"### Circuit to Tensors\n",
9090
"The circuit defines a tensor network representation. By default, the initial state is the `|0...0>` state (represented by the \"zero qubit\" operations labeled \"Q0\" in the legend. \"Q1\" are single qubit operations and \"Q2\" are two qubit operations. The open legs are the indices into the state vector and are of the form \"i{m}_q{n}\" where `m` is the time index (given by the returned `qubit_frontier` dictionary) and \"n\" is the qubit string.\n",
9191
"\n",
92-
"Note: this notebook relies on unreleased Cirq features. If you want to try these features, make sure you install cirq via `pip install cirq --pre`."
92+
"Note: this notebook relies on unreleased Cirq features. If you want to try these features, make sure you install cirq via `pip install cirq~=1.0.dev`."
9393
]
9494
},
9595
{

cirq-core/cirq/contrib/quimb/Contract-a-Grid-Circuit.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"metadata": {},
66
"source": [
77
"## Setup\n",
8-
"Note: this notebook relies on unreleased Cirq features. If you want to try these features, make sure you install cirq via `pip install cirq --pre`."
8+
"Note: this notebook relies on unreleased Cirq features. If you want to try these features, make sure you install cirq via `pip install cirq~=1.0.dev`."
99
]
1010
},
1111
{
@@ -20,14 +20,14 @@
2020
" import cirq\n",
2121
"except ImportError:\n",
2222
" print(\"installing cirq...\")\n",
23-
" !pip install --quiet cirq --pre\n",
23+
" !pip install --quiet cirq~=1.0.dev\n",
2424
" print(\"installed cirq.\")\n",
2525
"\n",
2626
"try:\n",
2727
" import quimb\n",
2828
"except ImportError:\n",
2929
" print(\"installing cirq-core[contrib]...\")\n",
30-
" !pip install --quiet 'cirq-core[contrib]' --pre\n",
30+
" !pip install --quiet 'cirq-core[contrib]~=1.0.dev'\n",
3131
" print(\"installed cirq-core[contrib].\")"
3232
]
3333
},
@@ -38,7 +38,7 @@
3838
"# Contract a Grid Circuit\n",
3939
"Shallow circuits on a planar grid with low-weight observables permit easy contraction.\n",
4040
"\n",
41-
"Note: this notebook relies on unreleased Cirq features. If you want to try these features, make sure you install cirq via `pip install cirq --pre`."
41+
"Note: this notebook relies on unreleased Cirq features. If you want to try these features, make sure you install cirq via `pip install cirq~=1.0.dev`."
4242
]
4343
},
4444
{

cirq-ft/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ To install the pre-release version of **cirq-ft**, use
1616

1717
.. code-block:: bash
1818
19-
pip install cirq-ft --pre
19+
pip install cirq-ft~=1.0.dev
2020
2121
2222
2323
Note, that this will install both cirq-ft and cirq-core as well.
2424

2525
To get all the optional **Cirq** modules installed as well, use `pip install cirq` or
26-
`pip install cirq --pre` for the pre-release version.
26+
`pip install cirq~=1.0.dev` for the pre-release version.

cirq-google/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Installation
2323
------------
2424

2525
To install the stable version of only **cirq-google**, use `pip install cirq-google`.
26-
To install the pre-release version of only **cirq-google**, use `pip install cirq-google --pre`.
26+
To install the pre-release version of only **cirq-google**, use `pip install cirq-google~=1.0.dev`.
2727

2828
Note, that this will install both cirq-google and cirq-core as well.
2929

30-
To get all the optional modules installed as well, you'll have to use `pip install cirq` or `pip install cirq --pre` for the pre-release version.
30+
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-ionq/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Installation
2020
------------
2121

2222
To install the stable version of only **cirq-ionq**, use `pip install cirq-ionq`.
23-
To install the pre-release version of only **cirq-ionq**, use `pip install cirq-ionq --pre`.
23+
To install the pre-release version of only **cirq-ionq**, use `pip install cirq-ionq~=1.0.dev`.
2424

2525
Note, that this will install both **cirq-ionq** and **cirq-core**.
2626

27-
To get all the optional modules installed, you'll have to use `pip install cirq` or `pip install cirq --pre` for the pre-release version.
27+
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-pasqal/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Installation
2020
------------
2121

2222
To install the stable version of only **cirq-pasqal**, use `pip install cirq-pasqal`.
23-
To install the pre-release version of only **cirq-pasqal**, use `pip install cirq-pasqal --pre`.
23+
To install the pre-release version of only **cirq-pasqal**, use `pip install cirq-pasqal~=1.0.dev`.
2424

2525
Note, that this will install both **cirq-pasqal** and **cirq-core**.
2626

27-
To get all the optional modules installed, you'll have to use `pip install cirq` or `pip install cirq --pre` for the pre-release version.
27+
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.

0 commit comments

Comments
 (0)