Skip to content

Commit

Permalink
Cleaning up cirq/install docs (quantumlib#5178)
Browse files Browse the repository at this point in the history 
* Corrected virtual environment link.
* Replaced Foxtail with Sycamore.
  • Loading branch information
@verult @rht
verult authored and rht committed May 1, 2023
1 parent a2ee582 commit eff0258
Showing 1 changed file with 89 additions and 17 deletions.
106 changes: 89 additions & 17 deletions docs/install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To be informed of deprecations and breaking changes, subscribe to the

See [Installing Python 3 on Linux](https://docs.python-guide.org/starting/install3/linux/) @ the hitchhiker's guide to python.

1. Consider using a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtualenv/).
1. Consider using a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).

2. Use `pip` to install `cirq`:

Expand Down Expand Up @@ -51,12 +51,36 @@ To be informed of deprecations and breaking changes, subscribe to the
4. Check that it works!
```bash
python -c 'import cirq_google; print(cirq_google.Foxtail)'
python -c 'import cirq_google; print(cirq_google.Sycamore)'
# should print:
# (0, 0)───(0, 1)───(0, 2)───(0, 3)───(0, 4)───(0, 5)───(0, 6)───(0, 7)───(0, 8)───(0, 9)───(0, 10)
# │ │ │ │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │ │ │ │
# (1, 0)───(1, 1)───(1, 2)───(1, 3)───(1, 4)───(1, 5)───(1, 6)───(1, 7)───(1, 8)───(1, 9)───(1, 10)
# (0, 5)───(0, 6)
# │ │
# │ │
# (1, 4)───(1, 5)───(1, 6)───(1, 7)
# │ │ │ │
# │ │ │ │
# (2, 3)───(2, 4)───(2, 5)───(2, 6)───(2, 7)───(2, 8)
# │ │ │ │ │ │
# │ │ │ │ │ │
# (3, 2)───(3, 3)───(3, 4)───(3, 5)───(3, 6)───(3, 7)───(3, 8)───(3, 9)
# │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │
# (4, 1)───(4, 2)───(4, 3)───(4, 4)───(4, 5)───(4, 6)───(4, 7)───(4, 8)───(4, 9)
# │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │
# (5, 0)───(5, 1)───(5, 2)───(5, 3)───(5, 4)───(5, 5)───(5, 6)───(5, 7)───(5, 8)
# │ │ │ │ │ │ │
# │ │ │ │ │ │ │
# (6, 1)───(6, 2)───(6, 3)───(6, 4)───(6, 5)───(6, 6)───(6, 7)
# │ │ │ │ │
# │ │ │ │ │
# (7, 2)───(7, 3)───(7, 4)───(7, 5)───(7, 6)
# │ │ │
# │ │ │
# (8, 3)───(8, 4)───(8, 5)
# │
# │
# (9, 4)
```
Expand All @@ -66,7 +90,7 @@ To be informed of deprecations and breaking changes, subscribe to the
See [Installing Python 3 on Mac OS X](https://docs.python-guide.org/starting/install3/osx/) @ the hitchhiker's guide to python.

1. Consider using a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtualenv/).
1. Consider using a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).

2. Use `pip` to install `cirq`:

Expand All @@ -92,12 +116,36 @@ To be informed of deprecations and breaking changes, subscribe to the
4. Check that it works!
```bash
python -c 'import cirq_google; print(cirq_google.Foxtail)'
python -c 'import cirq_google; print(cirq_google.Sycamore)'
# should print:
# (0, 0)───(0, 1)───(0, 2)───(0, 3)───(0, 4)───(0, 5)───(0, 6)───(0, 7)───(0, 8)───(0, 9)───(0, 10)
# │ │ │ │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │ │ │ │
# (1, 0)───(1, 1)───(1, 2)───(1, 3)───(1, 4)───(1, 5)───(1, 6)───(1, 7)───(1, 8)───(1, 9)───(1, 10)
# (0, 5)───(0, 6)
# │ │
# │ │
# (1, 4)───(1, 5)───(1, 6)───(1, 7)
# │ │ │ │
# │ │ │ │
# (2, 3)───(2, 4)───(2, 5)───(2, 6)───(2, 7)───(2, 8)
# │ │ │ │ │ │
# │ │ │ │ │ │
# (3, 2)───(3, 3)───(3, 4)───(3, 5)───(3, 6)───(3, 7)───(3, 8)───(3, 9)
# │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │
# (4, 1)───(4, 2)───(4, 3)───(4, 4)───(4, 5)───(4, 6)───(4, 7)───(4, 8)───(4, 9)
# │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │
# (5, 0)───(5, 1)───(5, 2)───(5, 3)───(5, 4)───(5, 5)───(5, 6)───(5, 7)───(5, 8)
# │ │ │ │ │ │ │
# │ │ │ │ │ │ │
# (6, 1)───(6, 2)───(6, 3)───(6, 4)───(6, 5)───(6, 6)───(6, 7)
# │ │ │ │ │
# │ │ │ │ │
# (7, 2)───(7, 3)───(7, 4)───(7, 5)───(7, 6)
# │ │ │
# │ │ │
# (8, 3)───(8, 4)───(8, 5)
# │
# │
# (9, 4)
```
Expand Down Expand Up @@ -125,11 +173,35 @@ To be informed of deprecations and breaking changes, subscribe to the
4. Check that it works!

```bash
python -c "import cirq_google; print(cirq_google.Foxtail)"
python -c "import cirq_google; print(cirq_google.Sycamore)"
# should print:
# (0, 0)───(0, 1)───(0, 2)───(0, 3)───(0, 4)───(0, 5)───(0, 6)───(0, 7)───(0, 8)───(0, 9)───(0, 10)
# │ │ │ │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │ │ │ │
# (1, 0)───(1, 1)───(1, 2)───(1, 3)───(1, 4)───(1, 5)───(1, 6)───(1, 7)───(1, 8)───(1, 9)───(1, 10)
# (0, 5)───(0, 6)
# │ │
# │ │
# (1, 4)───(1, 5)───(1, 6)───(1, 7)
# │ │ │ │
# │ │ │ │
# (2, 3)───(2, 4)───(2, 5)───(2, 6)───(2, 7)───(2, 8)
# │ │ │ │ │ │
# │ │ │ │ │ │
# (3, 2)───(3, 3)───(3, 4)───(3, 5)───(3, 6)───(3, 7)───(3, 8)───(3, 9)
# │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │
# (4, 1)───(4, 2)───(4, 3)───(4, 4)───(4, 5)───(4, 6)───(4, 7)───(4, 8)───(4, 9)
# │ │ │ │ │ │ │ │
# │ │ │ │ │ │ │ │
# (5, 0)───(5, 1)───(5, 2)───(5, 3)───(5, 4)───(5, 5)───(5, 6)───(5, 7)───(5, 8)
# │ │ │ │ │ │ │
# │ │ │ │ │ │ │
# (6, 1)───(6, 2)───(6, 3)───(6, 4)───(6, 5)───(6, 6)───(6, 7)
# │ │ │ │ │
# │ │ │ │ │
# (7, 2)───(7, 3)───(7, 4)───(7, 5)───(7, 6)
# │ │ │
# │ │ │
# (8, 3)───(8, 4)───(8, 5)
# │
# │
# (9, 4)
```

0 comments on commit eff0258

Please sign in to comment.