From dbbca7393d43884c265eeb4f62e8a78230fa837c Mon Sep 17 00:00:00 2001 From: Doug Strain Date: Fri, 1 Dec 2023 06:09:36 -0800 Subject: [PATCH] Change master to main in documentation (#6365) - We are changing the default branch from master to main in order to conform to best practices and remove problematic terminology. - This PR changes references in documentation (mostly links) to use main. --- CONTRIBUTING.md | 18 ++++++------- README.rst | 10 +++---- cirq-core/README.rst | 2 +- cirq-ft/README.rst | 2 +- cirq-web/circuit_example.ipynb | 4 +-- docs/_template.ipynb | 4 +-- docs/build/circuits.ipynb | 4 +-- docs/build/classical_control.ipynb | 6 ++--- docs/build/custom_gates.ipynb | 4 +-- docs/build/gates.ipynb | 4 +-- docs/build/interop.ipynb | 6 ++--- docs/build/operators.ipynb | 4 +-- docs/build/pauli_observables.ipynb | 4 +-- docs/build/protocols.ipynb | 4 +-- docs/build/qubits.ipynb | 4 +-- docs/build/qudits.ipynb | 4 +-- docs/citation.md | 4 +-- docs/dev/development.md | 26 +++++++++---------- docs/dev/notebooks.md | 16 ++++++------ docs/dev/rfc_process.md | 4 +-- docs/dev/style.md | 6 ++--- docs/dev/triage.md | 4 +-- docs/dev/versions.md | 4 +-- docs/experiments/fourier_checking.ipynb | 4 +-- docs/experiments/hidden_linear_function.ipynb | 4 +-- docs/experiments/quantum_walks.ipynb | 6 ++--- docs/experiments/shor.ipynb | 6 ++--- docs/experiments/textbook_algorithms.ipynb | 6 ++--- docs/experiments/variational_algorithm.ipynb | 4 +-- docs/gatezoo.ipynb | 4 +-- docs/google/best_practices.ipynb | 4 +-- docs/google/concepts.ipynb | 14 +++++----- docs/google/internal_gates.ipynb | 4 +-- docs/google/qubit-placement.ipynb | 4 +-- docs/hardware/aqt/getting_started.ipynb | 4 +-- .../getting_started_honeywell.ipynb | 4 +-- .../azure-quantum/getting_started_ionq.ipynb | 4 +-- docs/hardware/devices.ipynb | 4 +-- docs/hardware/ionq/getting_started.ipynb | 4 +-- docs/hardware/pasqal/getting_started.ipynb | 4 +-- docs/hardware/qubit_picking.ipynb | 4 +-- docs/hardware/rigetti/getting_started.ipynb | 4 +-- docs/named_topologies.ipynb | 4 +-- docs/noise/calibration_api.ipynb | 4 +-- docs/noise/floquet_calibration_example.ipynb | 4 +-- docs/noise/heatmaps.ipynb | 4 +-- .../qcvv/coherent_vs_incoherent_xeb.ipynb | 4 +-- docs/noise/qcvv/isolated_xeb.ipynb | 4 +-- docs/noise/qcvv/parallel_xeb.ipynb | 4 +-- docs/noise/qcvv/xeb_calibration_example.ipynb | 4 +-- docs/noise/qcvv/xeb_theory.ipynb | 4 +-- docs/noise/representing_noise.ipynb | 16 ++++++------ docs/simulate/noisy_simulation.ipynb | 6 ++--- docs/simulate/params.ipynb | 4 +-- docs/simulate/quantum_virtual_machine.ipynb | 4 +-- docs/simulate/qvm_basic_example.ipynb | 4 +-- docs/simulate/qvm_builder_code.ipynb | 4 +-- docs/simulate/qvm_stabilizer_example.ipynb | 4 +-- docs/simulate/simulation.ipynb | 4 +-- docs/simulate/state_histograms.ipynb | 4 +-- docs/simulate/virtual_engine_interface.ipynb | 8 +++--- docs/start/basics.ipynb | 4 +-- docs/start/intro.ipynb | 4 +-- docs/start/start.ipynb | 4 +-- docs/transform/custom_transformers.ipynb | 4 +-- docs/transform/routing_transformer.ipynb | 4 +-- docs/transform/transformers.ipynb | 6 ++--- docs/tutorials/google/colab.ipynb | 14 +++++----- docs/tutorials/google/echoes.ipynb | 4 +-- .../google/identifying_hardware_changes.ipynb | 4 +-- docs/tutorials/google/spin_echoes.ipynb | 4 +-- docs/tutorials/google/start.ipynb | 16 ++++++------ .../visualizing_calibration_metrics.ipynb | 6 ++--- release.md | 22 ++++++++-------- 74 files changed, 215 insertions(+), 215 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e6a9d1c6d4..81e329bafc3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,27 +38,27 @@ Forking creates a new github repo at the location your github id. Use the directions on the [development page](docs/dev/development.md) to download a copy to your local machine. You need only do this once. -1. Checkout master and create a new branch from this master +1. Checkout main and create a new branch from this main ```shell - git checkout master -b new_branch_name + git checkout main -b new_branch_name ``` where ```new_branch_name``` is the name of your new branch. 1. Do your work and commit your changes to this branch. -1. If you have drifted out of sync with the master from the +1. If you have drifted out of sync with the main from the main cirq repo you may need to merge in changes. To do this, -first update your local master and then merge the local master +first update your local main and then merge the local main into your branch: ```shell # Track the upstream repo (if your local repo hasn't): git remote add upstream https://github.com/quantumlib/Cirq.git - # Update your local master. + # Update your local main. git fetch upstream - git checkout master - git merge upstream/master - # Merge local master into your branch. + git checkout main + git merge upstream/main + # Merge local main into your branch. git checkout new_branch_name - git merge master + git merge main ``` You may need to fix merge conflicts for both of these merge commands. diff --git a/README.rst b/README.rst index c54ea86510f..2d7d3a23c03 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/Cirq_logo_color.png +.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png :target: https://github.com/quantumlib/cirq :alt: Cirq :width: 500px @@ -10,7 +10,7 @@ circuits and running them against quantum computers and simulators. :target: https://github.com/quantumlib/Cirq :alt: Build Status -.. image:: https://codecov.io/gh/quantumlib/Cirq/branch/master/graph/badge.svg +.. 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 @@ -26,7 +26,7 @@ Installation and Documentation Cirq documentation is available at `quantumai.google/cirq `_. -Documentation for the latest **pre-release** version of cirq (tracks the repository's master branch; what you get if you ``pip install --pre cirq``), is available `here `__. +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 `__. Documentation for the latest **stable** version of cirq (what you get if you ``pip install cirq``) is available `here `__. @@ -98,10 +98,10 @@ Cirq Contributors Community --------------------------- We welcome contributions! Before opening your first PR, a good place to start is to read our -`guidelines `__. +`guidelines `__. We are dedicated to cultivating an open and inclusive community to build software for near term quantum computers. -Please read our `code of conduct `__ for the rules of engagement within our community. +Please read our `code of conduct `__ for the rules of engagement within our community. For real time informal discussions about Cirq, join our `cirqdev `__ Gitter channel, come hangout with us! diff --git a/cirq-core/README.rst b/cirq-core/README.rst index 43e1f8a0012..e1824ba30ea 100644 --- a/cirq-core/README.rst +++ b/cirq-core/README.rst @@ -1,4 +1,4 @@ -.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/Cirq_logo_color.png +.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png :target: https://github.com/quantumlib/cirq :alt: Cirq :width: 500px diff --git a/cirq-ft/README.rst b/cirq-ft/README.rst index df0f28943ef..9add59db921 100644 --- a/cirq-ft/README.rst +++ b/cirq-ft/README.rst @@ -1,4 +1,4 @@ -.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/Cirq_logo_color.png +.. image:: https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/Cirq_logo_color.png :target: https://github.com/quantumlib/cirq :alt: cirq-ft :width: 500px diff --git a/cirq-web/circuit_example.ipynb b/cirq-web/circuit_example.ipynb index fcdaf9151c4..22e66e01253 100644 --- a/cirq-web/circuit_example.ipynb +++ b/cirq-web/circuit_example.ipynb @@ -44,10 +44,10 @@ "\n", "\n", " \n", " \n", "
\n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", "
" ] diff --git a/docs/_template.ipynb b/docs/_template.ipynb index ab2c8724b1a..e09e779f666 100644 --- a/docs/_template.ipynb +++ b/docs/_template.ipynb @@ -51,10 +51,10 @@ " \">View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/build/circuits.ipynb b/docs/build/circuits.ipynb index efd29797fea..c5086a1cbf1 100644 --- a/docs/build/circuits.ipynb +++ b/docs/build/circuits.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/build/classical_control.ipynb b/docs/build/classical_control.ipynb index f953c2cf26d..798e8105f05 100644 --- a/docs/build/classical_control.ipynb +++ b/docs/build/classical_control.ipynb @@ -42,10 +42,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -309,7 +309,7 @@ "source": [ "The measurement key `a` is present both in the outer circuit and the `FrozenCircuit` nested within it, but these two keys are different due to their different scopes. After unrolling the inner circuit twice, these inner `a`s get prefixed by the repetition number and becomes new, separate measurement keys, `0:a` and `1:a`, that don't interact with each other or the original `a`. \n", "\n", - "More complex scoping behavior is described in the [classically controlled operation tests](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/ops/classically_controlled_operation_test.py)." + "More complex scoping behavior is described in the [classically controlled operation tests](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/ops/classically_controlled_operation_test.py)." ] }, { diff --git a/docs/build/custom_gates.ipynb b/docs/build/custom_gates.ipynb index 371b8ed3c2e..9ac1be522b0 100644 --- a/docs/build/custom_gates.ipynb +++ b/docs/build/custom_gates.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/build/gates.ipynb b/docs/build/gates.ipynb index f8e31b4e2fc..b68924f4724 100644 --- a/docs/build/gates.ipynb +++ b/docs/build/gates.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/build/interop.ipynb b/docs/build/interop.ipynb index 671c326fd1c..26030a28c44 100644 --- a/docs/build/interop.ipynb +++ b/docs/build/interop.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -179,7 +179,7 @@ "Most cirq objects come with serialization functionality added already. If you are adding a custom object (such as a custom gate), you can still serialize the object, but you will need to add the magic functions `_json_dict_` and `_from_json_dict_` to your object to do so.\n", "\n", "When de-serializing, in order to instantiate the correct object, you will also have to pass in a custom resolver. This is a function that will take as input the serialized `cirq_type` string and output a constructable class. See \n", - "[`cirq.protocols.json_serialization`](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/protocols/json_serialization.py) for more details." + "[`cirq.protocols.json_serialization`](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/protocols/json_serialization.py) for more details." ] }, { diff --git a/docs/build/operators.ipynb b/docs/build/operators.ipynb index 1f019d5257c..4fcb77f7f74 100644 --- a/docs/build/operators.ipynb +++ b/docs/build/operators.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/build/pauli_observables.ipynb b/docs/build/pauli_observables.ipynb index be7476471da..1c0904d198b 100644 --- a/docs/build/pauli_observables.ipynb +++ b/docs/build/pauli_observables.ipynb @@ -42,10 +42,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/build/protocols.ipynb b/docs/build/protocols.ipynb index 918ed5844c6..39eb3b32235 100644 --- a/docs/build/protocols.ipynb +++ b/docs/build/protocols.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/build/qubits.ipynb b/docs/build/qubits.ipynb index 63a0b96812e..2ae100ff543 100644 --- a/docs/build/qubits.ipynb +++ b/docs/build/qubits.ipynb @@ -43,10 +43,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/build/qudits.ipynb b/docs/build/qudits.ipynb index 3e46ec3c16c..ea7c5e07b82 100644 --- a/docs/build/qudits.ipynb +++ b/docs/build/qudits.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/citation.md b/docs/citation.md index 274f7877a70..bc44f5f1d1d 100644 --- a/docs/citation.md +++ b/docs/citation.md @@ -4,9 +4,9 @@ When using our projects, please cite them according to the following guide: | Project | Citation reference | |---------|--------------------| -| Cirq | https://github.com/quantumlib/Cirq/tree/master#how-to-cite-cirq | +| Cirq | https://github.com/quantumlib/Cirq/tree/main#how-to-cite-cirq | | OpenFermion | https://github.com/quantumlib/OpenFermion#how-to-cite | | ReCirq | https://github.com/quantumlib/ReCirq#how-to-cite-recirq | | qsim | https://github.com/quantumlib/qsim#how-to-cite-qsim | | Tensorflow Quantum |https://github.com/tensorflow/quantum#references| - \ No newline at end of file + diff --git a/docs/dev/development.md b/docs/dev/development.md index cff90f5aaa8..146e66df471 100644 --- a/docs/dev/development.md +++ b/docs/dev/development.md @@ -72,15 +72,15 @@ This remote can be used to merge changes from Cirq's main repository into your l You can check the branches that are on the ```upstream``` remote by running ```git remote -va``` or ```git branch -r```. -Most importantly you should see ```upstream/master``` listed. -1. Merge the upstream master into your local master so that it is up to date. +Most importantly you should see ```upstream/main``` listed. +1. Merge the upstream main into your local main so that it is up to date. ```shell - git checkout master - git merge upstream/master + git checkout main + git merge upstream/main ``` -At this point your local git master should be synced with the master from the main cirq repo. +At this point your local git main should be synced with the main from the main cirq repo. ## Setting up an environment @@ -159,9 +159,9 @@ get picked up! ## Protocol buffers [Protocol buffers](https://developers.google.com/protocol-buffers) are used in Cirq for converting circuits, gates, and other objects into a standard form that can be written and read by other programs. -Cirq's protobufs live at [cirq-google/api/v2](https://github.com/quantumlib/Cirq/tree/master/cirq-google/cirq_google/api/v2) and may need to be changed or extended from time to time. +Cirq's protobufs live at [cirq-google/api/v2](https://github.com/quantumlib/Cirq/tree/main/cirq-google/cirq_google/api/v2) and may need to be changed or extended from time to time. -If any protos are updated, their dependents can be rebuilt by calling the script [dev_tools/build-protos.sh](https://github.com/quantumlib/Cirq/tree/master/dev_tools). +If any protos are updated, their dependents can be rebuilt by calling the script [dev_tools/build-protos.sh](https://github.com/quantumlib/Cirq/tree/main/dev_tools). This script uses grpcio-tools and protobuf version 3.8.0 to generate the python proto api. ## Continuous integration and local testing @@ -177,7 +177,7 @@ mypy --config-file=dev_tools/conf/mypy.ini . ``` This can be a bit tedious, because you have to specify the configuration files each time. -A more convenient way to run checks is to via the scripts in the [check/](https://github.com/quantumlib/Cirq/tree/master/check) directory, which specify configuration arguments for you and cover more use cases: +A more convenient way to run checks is to via the scripts in the [check/](https://github.com/quantumlib/Cirq/tree/main/check) directory, which specify configuration arguments for you and cover more use cases: - **Fast checks (complete in seconds or tens of seconds)** @@ -255,8 +255,8 @@ A more convenient way to run checks is to via the scripts in the [check/](https: In the above, `[BASE_REVISION]` controls what commit is being compared against for an incremental check (e.g. in order to determine which files changed.) -If not specified, it defaults to the `upstream/master` branch if it exists, or -else the `origin/master` branch if it exists, or else the `master` branch. +If not specified, it defaults to the `upstream/main` branch if it exists, or +else the `origin/main` branch if it exists, or else the `main` branch. The actual commit used for comparison is the `git merge-base` of the base revision and the working directory. @@ -343,7 +343,7 @@ python dev_tools/requirements/reqs.py dev_tools/requirements/dev.env.txt ./dev_tools/packaging/publish-dev-package.sh EXPECTED_VERSION --test ``` - You must specify the EXPECTED_VERSION argument to match the version in [cirq/_version.py](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/_version.py), and it must contain the string `dev`. + You must specify the EXPECTED_VERSION argument to match the version in [cirq/_version.py](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/_version.py), and it must contain the string `dev`. This is to prevent accidentally uploading the wrong version. The script will append the current date and time to the expected version number before uploading to test pypi. @@ -376,13 +376,13 @@ python dev_tools/requirements/reqs.py dev_tools/requirements/dev.env.txt If everything goes smoothly, the script will finish by printing `VERIFIED`. -3. Set the version number in [cirq/_version.py](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/_version.py). +3. Set the version number in [cirq/_version.py](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/_version.py). Development versions end with `.dev` or `.dev#`. For example, `0.0.4.dev500` is a development version of the release version `0.0.4`. For a release, create a pull request turning `#.#.#.dev*` into `#.#.#` and a follow up pull request turning `#.#.#` into `(#+1).#.#.dev`. -4. Run [dev_tools/packaging/produce-package.sh](https://github.com/quantumlib/Cirq/blob/master/dev_tools/packaging/produce-package.sh) to produce pypi artifacts. +4. Run [dev_tools/packaging/produce-package.sh](https://github.com/quantumlib/Cirq/blob/main/dev_tools/packaging/produce-package.sh) to produce pypi artifacts. ```bash ./dev_tools/packaging/produce-package.sh dist diff --git a/docs/dev/notebooks.md b/docs/dev/notebooks.md index 137a2436b89..20cb8bbb0f6 100644 --- a/docs/dev/notebooks.md +++ b/docs/dev/notebooks.md @@ -34,14 +34,14 @@ feasible to do so. ## Editing the tree nav on the site: _book.yaml -If you are placing a guide or a tutorial on the site, please make sure you add an entry to the right place in the nav tree in [docs/_book.yaml](https://github.com/quantumlib/Cirq/blob/master/docs/_book.yaml). +If you are placing a guide or a tutorial on the site, please make sure you add an entry to the right place in the nav tree in [docs/_book.yaml](https://github.com/quantumlib/Cirq/blob/main/docs/_book.yaml). ## Testing Those notebooks that don't have any external dependencies (e.g. API calls, authentication) are tested on a continuous basis. -See the [`dev_tools/notebooks`](https://github.com/quantumlib/Cirq/tree/master/dev_tools/notebooks) directory for the two tests: -- [notebook_test.py](https://github.com/quantumlib/Cirq/blob/master/dev_tools/notebooks/notebook_test.py) - to test notebooks against the current branch -- [isolated_notebook_test.py](https://github.com/quantumlib/Cirq/blob/master/dev_tools/notebooks/isolated_notebook_test.py) - to test notebooks against the latest released version of Cirq. +See the [`dev_tools/notebooks`](https://github.com/quantumlib/Cirq/tree/main/dev_tools/notebooks) directory for the two tests: +- [notebook_test.py](https://github.com/quantumlib/Cirq/blob/main/dev_tools/notebooks/notebook_test.py) - to test notebooks against the current branch +- [isolated_notebook_test.py](https://github.com/quantumlib/Cirq/blob/main/dev_tools/notebooks/isolated_notebook_test.py) - to test notebooks against the latest released version of Cirq. In order to speed up the execution of these tests an auxiliary file may be supplied which performs substitutions on the notebook to make it faster (for example it is often useful to reduce the number of repetitions in sampling from a simulator). @@ -79,21 +79,21 @@ When you introduce a notebook that depends on pre-release features of Cirq, make - mark the notebook at the top that `Note: this notebook relies on unreleased Cirq features. If you want to try these feature, make sure you install cirq via pip install cirq --pre`. - use `pip install cirq —pre` in the installation instructions - - make sure [notebook_test.py](https://github.com/quantumlib/Cirq/blob/master/dev_tools/notebooks/notebook_test.py) covers the notebook - - exclude the notebook from the [isolated_notebook_test.py](https://github.com/quantumlib/Cirq/blob/master/dev_tools/notebooks/isolated_notebook_test.py) by adding it to `NOTEBOOKS_DEPENDING_ON_UNRELEASED_FEATURES` + - make sure [notebook_test.py](https://github.com/quantumlib/Cirq/blob/main/dev_tools/notebooks/notebook_test.py) covers the notebook + - exclude the notebook from the [isolated_notebook_test.py](https://github.com/quantumlib/Cirq/blob/main/dev_tools/notebooks/isolated_notebook_test.py) by adding it to `NOTEBOOKS_DEPENDING_ON_UNRELEASED_FEATURES` ### Stable notebooks When you introduce a notebook that only uses already released features of Cirq, make sure to - use `pip install cirq` (NOT `pip install cirq --pre`) - - ensure the notebook is not excluded from either [notebook_test.py](https://github.com/quantumlib/Cirq/blob/master/dev_tools/notebooks/notebook_test.py) or [isolated_notebook_test.py](https://github.com/quantumlib/Cirq/blob/master/dev_tools/notebooks/isolated_notebook_test.py) (except if the notebook has external dependencies, in which case you should exclude this from both!) + - ensure the notebook is not excluded from either [notebook_test.py](https://github.com/quantumlib/Cirq/blob/main/dev_tools/notebooks/notebook_test.py) or [isolated_notebook_test.py](https://github.com/quantumlib/Cirq/blob/main/dev_tools/notebooks/isolated_notebook_test.py) (except if the notebook has external dependencies, in which case you should exclude this from both!) ### Release At release time, we change all the **pre-release notebooks** in bulk: - remove the pre-release notices - change `pip install cirq —pre` to `pip install cirq` - - remove the exclusions in [isolated_notebook_test.py](https://github.com/quantumlib/Cirq/blob/master/dev_tools/notebooks/isolated_notebook_test.py) by making `NOTEBOOKS_DEPENDING_ON_UNRELEASED_FEATURES=[]` + - remove the exclusions in [isolated_notebook_test.py](https://github.com/quantumlib/Cirq/blob/main/dev_tools/notebooks/isolated_notebook_test.py) by making `NOTEBOOKS_DEPENDING_ON_UNRELEASED_FEATURES=[]` As all the notebooks have been tested continuously up to this point, the release notebook PR should pass without issues. diff --git a/docs/dev/rfc_process.md b/docs/dev/rfc_process.md index 527f04a45e9..e413dd9836a 100644 --- a/docs/dev/rfc_process.md +++ b/docs/dev/rfc_process.md @@ -89,10 +89,10 @@ If you are working on new code to implement an RFC: * Make sure you understand the feature and the design approved in the RFC. Ask questions and discuss the approach before beginning work. * New features must include new unit tests that verify the feature works as expected. * Add or update relevant API documentation. Reference the RFC in the new documentation. -* Follow any other guidelines laid out in the [CONTRIBUTING.md](https://github.com/quantumlib/Cirq/blob/master/CONTRIBUTING.md) file in the project repo you're contributing to. +* Follow any other guidelines laid out in the [CONTRIBUTING.md](https://github.com/quantumlib/Cirq/blob/main/CONTRIBUTING.md) file in the project repo you're contributing to. * Run unit tests before submitting your code. * Work with the RFC sponsor to successfully land the new code. This could include PR / marketing of the new feature as well. -* Follow the Cirq process of deprecating code. Please refer to [\_compat.py](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/_compat.py) as an example. +* Follow the Cirq process of deprecating code. Please refer to [\_compat.py](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/_compat.py) as an example. ## Keeping the bar high diff --git a/docs/dev/style.md b/docs/dev/style.md index 6ec1bd4b7c5..41612090dcd 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md @@ -1,9 +1,9 @@ # Style guidelines -As mentioned in [CONTRIBUTING.md](https://github.com/quantumlib/Cirq/blob/master/CONTRIBUTING.md) we use use [pylint](https://pylint.pycqa.org/) +As mentioned in [CONTRIBUTING.md](https://github.com/quantumlib/Cirq/blob/main/CONTRIBUTING.md) we use use [pylint](https://pylint.pycqa.org/) to check for style violations. Pylint attempts to enforce styles in [PEP 8](https://www.python.org/dev/peps/pep-0008/). To see which lint checks we enforce, see the -[dev_tools/conf/.pylintrc](https://github.com/quantumlib/Cirq/blob/master/dev_tools/conf/.pylintrc) file. +[dev_tools/conf/.pylintrc](https://github.com/quantumlib/Cirq/blob/main/dev_tools/conf/.pylintrc) file. Here we include some extra style guidelines. @@ -115,4 +115,4 @@ them to "aware" objects or use their `.timestamp()` properties for a comparison never throw an exception. Absolutely do not use `datetime.utcnow()` as explained in the warnings in the -Python [documentation](https://docs.python.org/3/library/datetime.html). \ No newline at end of file +Python [documentation](https://docs.python.org/3/library/datetime.html). diff --git a/docs/dev/triage.md b/docs/dev/triage.md index d049be7e973..2a2b9667615 100644 --- a/docs/dev/triage.md +++ b/docs/dev/triage.md @@ -156,7 +156,7 @@ To summarize, **all issues** are subject to staleness-check, **except** the foll * `kind/roadmap-item` * `kind/task` -The staleness check automation is implemented via Github Actions, the latest definition of staleness is defined in [our staleness Github Action workflow](https://github.com/quantumlib/Cirq/blob/master/.github/workflows/stale.yml). +The staleness check automation is implemented via Github Actions, the latest definition of staleness is defined in [our staleness Github Action workflow](https://github.com/quantumlib/Cirq/blob/main/.github/workflows/stale.yml). ## Processes @@ -235,4 +235,4 @@ Cirq Cynque should be the place to discuss **What:** -Every 6 months, after every other release, the team should come together and review `triage/accepted` items and revisit them. This is also a chance to catchup on daily triage in case it slipped. \ No newline at end of file +Every 6 months, after every other release, the team should come together and review `triage/accepted` items and revisit them. This is also a chance to catchup on daily triage in case it slipped. diff --git a/docs/dev/versions.md b/docs/dev/versions.md index 0f95540f9ec..75ae655ec28 100644 --- a/docs/dev/versions.md +++ b/docs/dev/versions.md @@ -17,7 +17,7 @@ The public APIs of Cirq are backwards compatible across minor and patch versions * Private symbols: any symbol whose name start with an underscore **\_**. * Experimental and `cirq.contrib` symbols, see [below](#what-is-not-covered) for details. * Note that only code reachable through the `cirq` Python module is covered by the compatibility guarantees. - * For example: Code in the [examples/](https://github.com/quantumlib/Cirq/tree/master/examples) and [dev\_tools/](https://github.com/quantumlib/Cirq/tree/master/dev_tools) directories is not reachable through the `cirq` Python module and is thus not covered by the compatibility guarantee. + * For example: Code in the [examples/](https://github.com/quantumlib/Cirq/tree/main/examples) and [dev\_tools/](https://github.com/quantumlib/Cirq/tree/main/dev_tools) directories is not reachable through the `cirq` Python module and is thus not covered by the compatibility guarantee. * Similarly, symbols in vendor packages, like [cirq-google](https://quantumai.google/reference/python/cirq_google/all_symbols), [cirq-aqt](https://quantumai.google/reference/python/cirq_aqt/all_symbols) are also not covered by the compatibility guarantee. * If a symbol is available through the `cirq` Python module or its submodules, but is not documented, then it is **not** considered part of the public API. @@ -41,4 +41,4 @@ Cirq currently uses JSON serialization for serializing gates, operations and cir We make additional guarantees for _supported_ Cirq serialized objects. A serialized object which was created using **only non-deprecated, non-experimental APIs** in Cirq major version `N` is a _supported serialization in version `N`_. Any serialized object supported in Cirq major version `N` can be loaded and executed with Cirq major version `N+1`. However, the functionality required to build or modify such an object may not be available anymore, so this guarantee only applies to the unmodified serialized objects. -We will endeavor to preserve backwards compatibility as long as possible, so that the serialized objects are usable over long periods of time. \ No newline at end of file +We will endeavor to preserve backwards compatibility as long as possible, so that the serialized objects are usable over long periods of time. diff --git a/docs/experiments/fourier_checking.ipynb b/docs/experiments/fourier_checking.ipynb index 8fceae064d0..f74c4db41b7 100644 --- a/docs/experiments/fourier_checking.ipynb +++ b/docs/experiments/fourier_checking.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/experiments/hidden_linear_function.ipynb b/docs/experiments/hidden_linear_function.ipynb index 68341d03c61..2893028e352 100644 --- a/docs/experiments/hidden_linear_function.ipynb +++ b/docs/experiments/hidden_linear_function.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/experiments/quantum_walks.ipynb b/docs/experiments/quantum_walks.ipynb index 6cc1ccd8573..8ed2d0f4b0a 100644 --- a/docs/experiments/quantum_walks.ipynb +++ b/docs/experiments/quantum_walks.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -399,7 +399,7 @@ "\n", "\n", " The probability of measuring one of the basis states is given by squaring the coefficient in the linear combination, which we can see for both outcomes is equal to $0.5$, the same probability of a step to the \n", - " right/step to the left that we originally desired. We can now combine our operators into one \"master operator\" \n", + " right/step to the left that we originally desired. We can now combine our operators into one complete operator \n", " that works as one complete step of the random walk, including randomizing the coin vector:\n", "\n", "\n", diff --git a/docs/experiments/shor.ipynb b/docs/experiments/shor.ipynb index da8883fa710..34ade59c7b4 100644 --- a/docs/experiments/shor.ipynb +++ b/docs/experiments/shor.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -68,7 +68,7 @@ "id": "EDjKq6XBYArE" }, "source": [ - "This tutorial presents a pedagogical demonstration of Shor's algorithm. It is a modified and expanded version of [this Cirq example](https://github.com/quantumlib/Cirq/blob/master/examples/shor.py)." + "This tutorial presents a pedagogical demonstration of Shor's algorithm. It is a modified and expanded version of [this Cirq example](https://github.com/quantumlib/Cirq/blob/main/examples/shor.py)." ] }, { diff --git a/docs/experiments/textbook_algorithms.ipynb b/docs/experiments/textbook_algorithms.ipynb index 9bec52408b1..00467e09cc7 100644 --- a/docs/experiments/textbook_algorithms.ipynb +++ b/docs/experiments/textbook_algorithms.ipynb @@ -43,10 +43,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -60,7 +60,7 @@ "id": "lORoela1QICx" }, "source": [ - "In this notebook we'll run through some Cirq implementations of some of the standard algorithms that one encounters in an introductory quantum computing course. In particular, we will discuss the quantum teleportation algorithm, quantum Fourier transform, phase estimation algorithm, and Grover's algorithm. The discussion here is expanded from examples found in the [Cirq examples](https://github.com/quantumlib/Cirq/tree/master/examples) directory." + "In this notebook we'll run through some Cirq implementations of some of the standard algorithms that one encounters in an introductory quantum computing course. In particular, we will discuss the quantum teleportation algorithm, quantum Fourier transform, phase estimation algorithm, and Grover's algorithm. The discussion here is expanded from examples found in the [Cirq examples](https://github.com/quantumlib/Cirq/tree/main/examples) directory." ] }, { diff --git a/docs/experiments/variational_algorithm.ipynb b/docs/experiments/variational_algorithm.ipynb index f2b3d36a2ab..98a7e64fea1 100644 --- a/docs/experiments/variational_algorithm.ipynb +++ b/docs/experiments/variational_algorithm.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/gatezoo.ipynb b/docs/gatezoo.ipynb index 6aedc11c7db..6f698e5bfa5 100644 --- a/docs/gatezoo.ipynb +++ b/docs/gatezoo.ipynb @@ -43,10 +43,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/google/best_practices.ipynb b/docs/google/best_practices.ipynb index 40e9e93ff5e..c0f65ff5cb6 100644 --- a/docs/google/best_practices.ipynb +++ b/docs/google/best_practices.ipynb @@ -42,10 +42,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/google/concepts.ipynb b/docs/google/concepts.ipynb index f67725f102c..b1b6ab8c5e1 100644 --- a/docs/google/concepts.ipynb +++ b/docs/google/concepts.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -142,7 +142,7 @@ "\n", "Quantum Engine is the name of the cloud API which one can call to run the circuits you create in Cirq on quantum computers. When access is enabled, users can call this API to run circuits on Google’s quantum hardware. Read more about how to do this using cirq's `Engine` class [here](./engine.md).\n", "\n", - "![Quantum Engine Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/master/docs/images/engine_diagram.png?raw=1)" + "![Quantum Engine Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/main/docs/images/engine_diagram.png?raw=1)" ] }, { @@ -155,7 +155,7 @@ "\n", "In Cirq, one creates a `Circuit` in Python. If one then wants to run it using Quantum Engine, one must then upload this Circuit to the Quantum Engine API. The uploaded version of the Circuit is called a Program. Programs are not the Python code itself, but a representation of the Circuit suitable for running on hardware. The `Engine` class and its corresponding `sampler` will translate the circuit into the format needed by the API for you. You will need to make sure that your circuit uses only gates and qubits compatible with the hardware (see `cirq_google.optimized_for_sycamore()` to help with this).\n", "\n", - "![Quantum Program Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/master/docs/images/engine_program.png?raw=1)\n", + "![Quantum Program Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/main/docs/images/engine_program.png?raw=1)\n", "\n", "When you upload a program to Quantum Engine, the program is given a name. The organizational unit of Quantum Engine is the cloud project (see below), so when you create a program it is identified by the project id and the program id. We write this as a path\n", "\n", @@ -174,7 +174,7 @@ "\n", "Quantum Engine interfaces with Google Cloud. In Google Cloud, one can create different projects with different names. It is typical to create one project for each experiment you run on the quantum computer, to keep data and access compartmentalized. Everything under your cloud project can be seen by navigating to the Google Cloud console. Here, for example, we see the programs that have been uploaded to a quantum projected called “Quantum Cloud Client”:\n", "\n", - "![Quantum Cloud Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/master/docs/images/engine_cloud.png?raw=1)\n", + "![Quantum Cloud Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/main/docs/images/engine_cloud.png?raw=1)\n", "\n", "See the [Getting Started](../tutorials/google/start.ipynb) guide for step-by-step instructions on how to create a project and enable the API." ] @@ -189,7 +189,7 @@ "\n", "Once a circuit has been uploaded as a program to Quantum Engine, you can run this program by creating a job. When you create a job on Quantum Engine, the quantum engine then is responsible for routing your program and the information about the job to the appropriate quantum processor. Note that there is a time limit for job length, so you will want to separate your programs into multiple jobs below this limit.\n", "\n", - "![Quantum Jobs Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/master/docs/images/engine_job.png?raw=1)\n", + "![Quantum Jobs Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/main/docs/images/engine_job.png?raw=1)\n", "\n", "Quantum Engine is designed so that you can upload a program once and then, if that program has different parameters (see below), you can run this program multiple times by creating multiple jobs for a given program. Jobs are associated with programs, so they have names which include everything about your program, plus a job id:\n", "\n", @@ -219,7 +219,7 @@ "\n", "Once a job has been scheduled to run on a quantum processor, the machine returns the results of the program to the Quantum Engine. The Quantum Engine stores these results. Users can then query for these results:\n", "\n", - "![Quantum Results Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/master/docs/images/engine_result.png?raw=1)\n", + "![Quantum Results Conceptual Diagram](https://github.com/quantumlib/Cirq/blob/main/docs/images/engine_result.png?raw=1)\n", "\n", "There is only one result for one job, so results can be identified via the identity of the job followed by result:\n", "\n", diff --git a/docs/google/internal_gates.ipynb b/docs/google/internal_gates.ipynb index f534f5d52a4..80a4ed95837 100644 --- a/docs/google/internal_gates.ipynb +++ b/docs/google/internal_gates.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/google/qubit-placement.ipynb b/docs/google/qubit-placement.ipynb index ed894d73b12..b334eb65103 100644 --- a/docs/google/qubit-placement.ipynb +++ b/docs/google/qubit-placement.ipynb @@ -54,10 +54,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/hardware/aqt/getting_started.ipynb b/docs/hardware/aqt/getting_started.ipynb index 3b204b928f9..a37156a9464 100644 --- a/docs/hardware/aqt/getting_started.ipynb +++ b/docs/hardware/aqt/getting_started.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/hardware/azure-quantum/getting_started_honeywell.ipynb b/docs/hardware/azure-quantum/getting_started_honeywell.ipynb index 378fdfe573e..80d247c5dc5 100644 --- a/docs/hardware/azure-quantum/getting_started_honeywell.ipynb +++ b/docs/hardware/azure-quantum/getting_started_honeywell.ipynb @@ -12,10 +12,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/hardware/azure-quantum/getting_started_ionq.ipynb b/docs/hardware/azure-quantum/getting_started_ionq.ipynb index ac7afb3aecb..747b0bca246 100644 --- a/docs/hardware/azure-quantum/getting_started_ionq.ipynb +++ b/docs/hardware/azure-quantum/getting_started_ionq.ipynb @@ -12,10 +12,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/hardware/devices.ipynb b/docs/hardware/devices.ipynb index 87b50481a41..63c86e0a727 100644 --- a/docs/hardware/devices.ipynb +++ b/docs/hardware/devices.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/hardware/ionq/getting_started.ipynb b/docs/hardware/ionq/getting_started.ipynb index b49f48013c5..695c2f6a4be 100644 --- a/docs/hardware/ionq/getting_started.ipynb +++ b/docs/hardware/ionq/getting_started.ipynb @@ -20,10 +20,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/hardware/pasqal/getting_started.ipynb b/docs/hardware/pasqal/getting_started.ipynb index ad814e8e596..49fb428e5a3 100644 --- a/docs/hardware/pasqal/getting_started.ipynb +++ b/docs/hardware/pasqal/getting_started.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/hardware/qubit_picking.ipynb b/docs/hardware/qubit_picking.ipynb index 26584efc9c0..fb356dadfb2 100644 --- a/docs/hardware/qubit_picking.ipynb +++ b/docs/hardware/qubit_picking.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/hardware/rigetti/getting_started.ipynb b/docs/hardware/rigetti/getting_started.ipynb index 217a2da6837..f4a470142f8 100644 --- a/docs/hardware/rigetti/getting_started.ipynb +++ b/docs/hardware/rigetti/getting_started.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/named_topologies.ipynb b/docs/named_topologies.ipynb index d5471dbdd43..4a151481e98 100644 --- a/docs/named_topologies.ipynb +++ b/docs/named_topologies.ipynb @@ -53,10 +53,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/calibration_api.ipynb b/docs/noise/calibration_api.ipynb index dedf35800d6..80ab1625830 100644 --- a/docs/noise/calibration_api.ipynb +++ b/docs/noise/calibration_api.ipynb @@ -53,10 +53,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/floquet_calibration_example.ipynb b/docs/noise/floquet_calibration_example.ipynb index ac2930468f7..3f67de45c65 100644 --- a/docs/noise/floquet_calibration_example.ipynb +++ b/docs/noise/floquet_calibration_example.ipynb @@ -53,10 +53,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/heatmaps.ipynb b/docs/noise/heatmaps.ipynb index d03d3009aef..06610b1db2c 100644 --- a/docs/noise/heatmaps.ipynb +++ b/docs/noise/heatmaps.ipynb @@ -42,10 +42,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/qcvv/coherent_vs_incoherent_xeb.ipynb b/docs/noise/qcvv/coherent_vs_incoherent_xeb.ipynb index 9e95d87c1d7..3b451de9adb 100644 --- a/docs/noise/qcvv/coherent_vs_incoherent_xeb.ipynb +++ b/docs/noise/qcvv/coherent_vs_incoherent_xeb.ipynb @@ -51,10 +51,10 @@ " \">View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/qcvv/isolated_xeb.ipynb b/docs/noise/qcvv/isolated_xeb.ipynb index f1a014852ad..f29b827f7e0 100644 --- a/docs/noise/qcvv/isolated_xeb.ipynb +++ b/docs/noise/qcvv/isolated_xeb.ipynb @@ -42,10 +42,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/qcvv/parallel_xeb.ipynb b/docs/noise/qcvv/parallel_xeb.ipynb index e4159200017..920f14b0b52 100644 --- a/docs/noise/qcvv/parallel_xeb.ipynb +++ b/docs/noise/qcvv/parallel_xeb.ipynb @@ -42,10 +42,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/qcvv/xeb_calibration_example.ipynb b/docs/noise/qcvv/xeb_calibration_example.ipynb index 8ff0731ee73..a2c928eba4e 100644 --- a/docs/noise/qcvv/xeb_calibration_example.ipynb +++ b/docs/noise/qcvv/xeb_calibration_example.ipynb @@ -53,10 +53,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/qcvv/xeb_theory.ipynb b/docs/noise/qcvv/xeb_theory.ipynb index 97b55d69e67..417c0b44170 100644 --- a/docs/noise/qcvv/xeb_theory.ipynb +++ b/docs/noise/qcvv/xeb_theory.ipynb @@ -34,10 +34,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/noise/representing_noise.ipynb b/docs/noise/representing_noise.ipynb index 7a40ca8621e..fe88b344e86 100644 --- a/docs/noise/representing_noise.ipynb +++ b/docs/noise/representing_noise.ipynb @@ -42,10 +42,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -98,7 +98,7 @@ "\n", "**Coherent** errors apply a reversible (but unknown) transformation, such as making every $Z$ gate instead behave as $Z^{1.01}$. This can be represented by inserting [gates](../build/gates.ipynb) into the intended circuit.\n", "\n", - "**Incoherent** errors cause [decoherence](https://en.wikipedia.org/wiki/Quantum_decoherence#Non-unitary_modelling_examples) of the quantum state, and are irreversible as a result. This is equivalent to applying an operation with some probability $0 < P < 1$, and can be represented with Cirq \"channels\". [`ops/common_channels.py`](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/ops/common_channels.py) defines channels for some of the most common incoherent errors, which are described below." + "**Incoherent** errors cause [decoherence](https://en.wikipedia.org/wiki/Quantum_decoherence#Non-unitary_modelling_examples) of the quantum state, and are irreversible as a result. This is equivalent to applying an operation with some probability $0 < P < 1$, and can be represented with Cirq \"channels\". [`ops/common_channels.py`](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/ops/common_channels.py) defines channels for some of the most common incoherent errors, which are described below." ] }, { @@ -400,7 +400,7 @@ "source": [ "### Custom channels\n", "\n", - "`cirq.MixedUnitaryChannel` (in [`ops/mixed_unitary_channel.py`](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/ops/mixed_unitary_channel.py)) is a customizable channel which can represent any probabilistic mixture of unitary operators. It accepts an optional measurement key to capture which operator was selected." + "`cirq.MixedUnitaryChannel` (in [`ops/mixed_unitary_channel.py`](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/ops/mixed_unitary_channel.py)) is a customizable channel which can represent any probabilistic mixture of unitary operators. It accepts an optional measurement key to capture which operator was selected." ] }, { @@ -432,7 +432,7 @@ "id": "baf9cefb1aac" }, "source": [ - "`cirq.KrausChannel` (in [`ops/kraus_channel.py`](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/ops/kraus_channel.py)) is similar, but supports non-unitary operators." + "`cirq.KrausChannel` (in [`ops/kraus_channel.py`](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/ops/kraus_channel.py)) is similar, but supports non-unitary operators." ] }, { @@ -484,7 +484,7 @@ "source": [ "## NoiseModels\n", "\n", - "Built-in `cirq.NoiseModel` types do not have a shared home like channels, but a couple of commonly-used types are listed here. For more complex experiments, it is often useful to define your own `NoiseModel` subclasses; refer to [`devices/noise_model.py`](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/devices/noise_model.py) to learn more." + "Built-in `cirq.NoiseModel` types do not have a shared home like channels, but a couple of commonly-used types are listed here. For more complex experiments, it is often useful to define your own `NoiseModel` subclasses; refer to [`devices/noise_model.py`](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/devices/noise_model.py) to learn more." ] }, { @@ -495,7 +495,7 @@ "source": [ "### Constant noise\n", "\n", - "`cirq.ConstantQubitNoiseModel` (in [`devices/noise_model.py`](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/devices/noise_model.py)) is a simple model which will insert the given gate after every operation in the target circuit. When \"trivially converting\" gates to `NoiseModel`s, this is the model that is used, but it isn't particularly representative of any real-world noise." + "`cirq.ConstantQubitNoiseModel` (in [`devices/noise_model.py`](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/devices/noise_model.py)) is a simple model which will insert the given gate after every operation in the target circuit. When \"trivially converting\" gates to `NoiseModel`s, this is the model that is used, but it isn't particularly representative of any real-world noise." ] }, { @@ -537,7 +537,7 @@ "source": [ "### Insertion noise\n", "\n", - "`cirq.devices.InsertionNoiseModel` (in [`devices/insertion_noise_model.py`](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/devices/insertion_noise_model.py)) inspects the circuit for operations matching user-specified identifiers, and inserts the corresponding noise operations after matching operations. This noise model is useful for applying specific noise to specific gates - for example, adding different depolarizing error to 1- and 2-qubit gates." + "`cirq.devices.InsertionNoiseModel` (in [`devices/insertion_noise_model.py`](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/devices/insertion_noise_model.py)) inspects the circuit for operations matching user-specified identifiers, and inserts the corresponding noise operations after matching operations. This noise model is useful for applying specific noise to specific gates - for example, adding different depolarizing error to 1- and 2-qubit gates." ] }, { diff --git a/docs/simulate/noisy_simulation.ipynb b/docs/simulate/noisy_simulation.ipynb index 5ddbffd341c..ba27b94c9b2 100644 --- a/docs/simulate/noisy_simulation.ipynb +++ b/docs/simulate/noisy_simulation.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -116,7 +116,7 @@ "id": "708b5b720a74" }, "source": [ - "Cirq defines many commonly used quantum channels in [`ops/common_channels.py`](https://github.com/quantumlib/Cirq/blob/master/cirq-core/cirq/ops/common_channels.py). For example, the single-qubit bit-flip channel\n", + "Cirq defines many commonly used quantum channels in [`ops/common_channels.py`](https://github.com/quantumlib/Cirq/blob/main/cirq-core/cirq/ops/common_channels.py). For example, the single-qubit bit-flip channel\n", "\n", "$$\n", "\\rho \\rightarrow (1 - p) \\rho + p X \\rho X\n", diff --git a/docs/simulate/params.ipynb b/docs/simulate/params.ipynb index c8916cab935..b0c6ed7c387 100644 --- a/docs/simulate/params.ipynb +++ b/docs/simulate/params.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/simulate/quantum_virtual_machine.ipynb b/docs/simulate/quantum_virtual_machine.ipynb index 1e50d5ea68c..f8142898fe3 100644 --- a/docs/simulate/quantum_virtual_machine.ipynb +++ b/docs/simulate/quantum_virtual_machine.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/simulate/qvm_basic_example.ipynb b/docs/simulate/qvm_basic_example.ipynb index 19c2a954fce..dcd8c548638 100644 --- a/docs/simulate/qvm_basic_example.ipynb +++ b/docs/simulate/qvm_basic_example.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/simulate/qvm_builder_code.ipynb b/docs/simulate/qvm_builder_code.ipynb index 53902f5d4d7..38aadda3ee9 100644 --- a/docs/simulate/qvm_builder_code.ipynb +++ b/docs/simulate/qvm_builder_code.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/simulate/qvm_stabilizer_example.ipynb b/docs/simulate/qvm_stabilizer_example.ipynb index 3827afaca21..73c1c9a3836 100644 --- a/docs/simulate/qvm_stabilizer_example.ipynb +++ b/docs/simulate/qvm_stabilizer_example.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/simulate/simulation.ipynb b/docs/simulate/simulation.ipynb index a2d1ab07aa5..301a66b39b9 100644 --- a/docs/simulate/simulation.ipynb +++ b/docs/simulate/simulation.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/simulate/state_histograms.ipynb b/docs/simulate/state_histograms.ipynb index 4103e1c359b..93c9a381dea 100644 --- a/docs/simulate/state_histograms.ipynb +++ b/docs/simulate/state_histograms.ipynb @@ -43,10 +43,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/simulate/virtual_engine_interface.ipynb b/docs/simulate/virtual_engine_interface.ipynb index 6da5cb1a722..a840f941370 100644 --- a/docs/simulate/virtual_engine_interface.ipynb +++ b/docs/simulate/virtual_engine_interface.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -125,7 +125,7 @@ "\n", "The easiest way to create a `cirq_google.SimulatedLocalEngine` is to make one from one or more processor templates. \n", "Example processor device specifications can be found in \n", - "the [devices/specifications](https://github.com/quantumlib/Cirq/tree/master/cirq-google/cirq_google/devices/specifications) folder of `cirq_google` in the Cirq Github repository. These device specifications closely match previous versions of Google quantum hardware, and can serve as templates for processors in a `SimulatedLocalEngine`. When Google hardware becomes publicly available again in the future, it will have device specifications like these that differ in details, but not in format.\n", + "the [devices/specifications](https://github.com/quantumlib/Cirq/tree/main/cirq-google/cirq_google/devices/specifications) folder of `cirq_google` in the Cirq Github repository. These device specifications closely match previous versions of Google quantum hardware, and can serve as templates for processors in a `SimulatedLocalEngine`. When Google hardware becomes publicly available again in the future, it will have device specifications like these that differ in details, but not in format.\n", "\n", "You can create a `cirq_google.SimulatedLocalEngine` that includes these example device specifications using `cirq_google.engine.create_noiseless_virtual_engine_from_latest_templates()`. For example:" ] @@ -378,7 +378,7 @@ "\n", "You can also create virtual engines from device specifications written in the [Protocol Buffer](https://developers.google.com/protocol-buffers) structured-data file format. This allows for detailed custom device creation, in the case where you want to see how a slightly modified existing device, or a completely new device, would work in Cirq.\n", "\n", - "The previous specification files mentioned in the [devices/specifications](https://github.com/quantumlib/Cirq/tree/master/cirq-google/cirq_google/devices/specifications) in the Cirq repository are already in this file format. The details of this format are subject to change as Cirq is updated, but it is designed to be human-readable. If you want to work with a very custom device, the best place to start is by inspecting one of these files, but be aware that the format may change without notice." + "The previous specification files mentioned in the [devices/specifications](https://github.com/quantumlib/Cirq/tree/main/cirq-google/cirq_google/devices/specifications) in the Cirq repository are already in this file format. The details of this format are subject to change as Cirq is updated, but it is designed to be human-readable. If you want to work with a very custom device, the best place to start is by inspecting one of these files, but be aware that the format may change without notice." ] }, { diff --git a/docs/start/basics.ipynb b/docs/start/basics.ipynb index 234a938f697..1a5a1eb3c00 100644 --- a/docs/start/basics.ipynb +++ b/docs/start/basics.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/start/intro.ipynb b/docs/start/intro.ipynb index 728e7962fa5..7079271e044 100644 --- a/docs/start/intro.ipynb +++ b/docs/start/intro.ipynb @@ -43,10 +43,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/start/start.ipynb b/docs/start/start.ipynb index fb53f6b8689..5f3b1e76fe8 100644 --- a/docs/start/start.ipynb +++ b/docs/start/start.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/transform/custom_transformers.ipynb b/docs/transform/custom_transformers.ipynb index b69e87ba259..ab4962f8408 100644 --- a/docs/transform/custom_transformers.ipynb +++ b/docs/transform/custom_transformers.ipynb @@ -43,10 +43,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/transform/routing_transformer.ipynb b/docs/transform/routing_transformer.ipynb index fc7695965a2..db845117781 100644 --- a/docs/transform/routing_transformer.ipynb +++ b/docs/transform/routing_transformer.ipynb @@ -43,10 +43,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/transform/transformers.ipynb b/docs/transform/transformers.ipynb index d61f243e412..945b13c2d52 100644 --- a/docs/transform/transformers.ipynb +++ b/docs/transform/transformers.ipynb @@ -43,10 +43,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -115,7 +115,7 @@ }, "source": [ "## Overview\n", - "Transformers that come with cirq can be found in the [`/cirq/transformers`](https://github.com/quantumlib/Cirq/tree/master/cirq-core/cirq/transformers) package.\n", + "Transformers that come with cirq can be found in the [`/cirq/transformers`](https://github.com/quantumlib/Cirq/tree/main/cirq-core/cirq/transformers) package.\n", "\n", "A few notable examples are:\n", "* **`cirq.align_left` / `cirq.align_right`**: Align gates to the left/right of the circuit by sliding them as far as possible along each qubit in the chosen direction.\n", diff --git a/docs/tutorials/google/colab.ipynb b/docs/tutorials/google/colab.ipynb index 770f180c698..f29c8f87bae 100644 --- a/docs/tutorials/google/colab.ipynb +++ b/docs/tutorials/google/colab.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -113,11 +113,11 @@ "## How to download iPython notebooks from GitHub\n", "\n", "You can retrieve iPython notebooks in the Cirq repository by\n", - "going to the [docs/ directory](https://github.com/quantumlib/Cirq/tree/master/docs). For instance, this Colab template is found [here](https://github.com/quantumlib/Cirq/blob/master/docs/tutorials/google/colab.ipynb). Select the file that you would like to download and then click the *Raw* button in the upper-right part of the window:\n", + "going to the [docs/ directory](https://github.com/quantumlib/Cirq/tree/main/docs). For instance, this Colab template is found [here](https://github.com/quantumlib/Cirq/blob/main/docs/tutorials/google/colab.ipynb). Select the file that you would like to download and then click the *Raw* button in the upper-right part of the window:\n", "\n", - "\"GitHub\n", + "\"GitHub\n", "\n", - "This will show the entire file contents. Right-click and select *Save as* to save this file to your computer. Make sure to save to a file with a `.ipynb` extension (you may need to select *All files* from the format dropdown instead of *text*). You can also get to this Colab's [raw content directly](https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/tutorials/google/colab.ipynb)\n", + "This will show the entire file contents. Right-click and select *Save as* to save this file to your computer. Make sure to save to a file with a `.ipynb` extension (you may need to select *All files* from the format dropdown instead of *text*). You can also get to this Colab's [raw content directly](https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/tutorials/google/colab.ipynb)\n", "\n", "You can also retrieve the entire Cirq repository by running the following command in a terminal that has `git` installed:\n", "\n", @@ -136,7 +136,7 @@ "\n", "You can open a new Colab notebook from your Google Drive window or by visiting the [Colab site](https://colab.research.google.com/notebooks/intro.ipynb). From the Colaboratory site, you can use the menu to upload an iPython notebook:\n", "\n", - "\"Google\n", + "\"Google\n", "\n", "This will upload the ipynb file that you downloaded before. You can now run all the commands, modify it to suit your goals, and share it with others.\n", "\n", @@ -163,7 +163,7 @@ "1. Enter the Cloud project ID you'd like to use in the `project_id` field.\n", "2. Then run the cell below (and go through the auth flow for access to the project id you entered).\n", "\n", - "\"Quantum" + "\"Quantum" ] }, { diff --git a/docs/tutorials/google/echoes.ipynb b/docs/tutorials/google/echoes.ipynb index 4c1c9e9931d..904a8a4c19e 100644 --- a/docs/tutorials/google/echoes.ipynb +++ b/docs/tutorials/google/echoes.ipynb @@ -53,10 +53,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/tutorials/google/identifying_hardware_changes.ipynb b/docs/tutorials/google/identifying_hardware_changes.ipynb index 54c14845934..c7ca5a5cd77 100644 --- a/docs/tutorials/google/identifying_hardware_changes.ipynb +++ b/docs/tutorials/google/identifying_hardware_changes.ipynb @@ -53,10 +53,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/tutorials/google/spin_echoes.ipynb b/docs/tutorials/google/spin_echoes.ipynb index 379257198b6..624127a4dd3 100644 --- a/docs/tutorials/google/spin_echoes.ipynb +++ b/docs/tutorials/google/spin_echoes.ipynb @@ -53,10 +53,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", diff --git a/docs/tutorials/google/start.ipynb b/docs/tutorials/google/start.ipynb index 0f910cd3bba..fdd02127785 100644 --- a/docs/tutorials/google/start.ipynb +++ b/docs/tutorials/google/start.ipynb @@ -51,10 +51,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -101,7 +101,7 @@ "\n", "Access is currently restricted to those in an approved group, and you must be in that group before running this tutorial.\n", "\n", - "You can find more about running this in colaboratory in the [Colab documentation](https://colab.research.google.com/notebooks/welcome.ipynb) or in our Cirq-specific guide to [running in Colab](colab.ipynb). You can download this notebook from the [GitHub repository](https://github.com/quantumlib/Cirq/blob/master/docs/tutorials/google/start.ipynb)." + "You can find more about running this in colaboratory in the [Colab documentation](https://colab.research.google.com/notebooks/welcome.ipynb) or in our Cirq-specific guide to [running in Colab](colab.ipynb). You can download this notebook from the [GitHub repository](https://github.com/quantumlib/Cirq/blob/main/docs/tutorials/google/start.ipynb)." ] }, { @@ -117,15 +117,15 @@ "\n", "After the API is enabled, you should be redirected to the [Quantum Engine console](https://console.cloud.google.com/quantum) and it should look like the following screenshot.\n", "\n", - "![Quantum Engine landing](https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/console-landing.png)\n", + "![Quantum Engine landing](https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/console-landing.png)\n", "\n", "**Enter your project id into the input text box below**. To find your project id, click on the project menu in the blue bar at the top of the console. This will open a menu that displays your project name (e.g. \"My project\") and unique **project id** (e.g. my-project-1234). Enter the **project id** into the input below. ([Help on finding your project id](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects).)\n", "\n", - "![Find project id](https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/console-project-id.png)\n", + "![Find project id](https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/console-project-id.png)\n", "\n", "**Run the code in the next block (the one with the text box)**, which will prompt you to authenticate Google Cloud SDK to use your project. After running the block, you will see a link which you should click. This will open a new browser window. Follow the authentication flow for this window. If you see \"Authentication complete\" you have done this step successfully. Contact your partner in the Quantum Hardware Residency Program if you encounter issues at this stage.\n", "\n", - "![Run code block below](https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/run-code-block.png)" + "![Run code block below](https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/run-code-block.png)" ] }, { @@ -288,7 +288,7 @@ "source": [ "After selecting your device, enter its ID in the following code block and run it as well.\n", "\n", - "![Run code block below](https://raw.githubusercontent.com/quantumlib/Cirq/master/docs/images/run-code-block.png)\n" + "![Run code block below](https://raw.githubusercontent.com/quantumlib/Cirq/main/docs/images/run-code-block.png)\n" ], "metadata": { "id": "m04izoTAu06T" @@ -584,4 +584,4 @@ }, "nbformat": 4, "nbformat_minor": 0 -} \ No newline at end of file +} diff --git a/docs/tutorials/google/visualizing_calibration_metrics.ipynb b/docs/tutorials/google/visualizing_calibration_metrics.ipynb index 337d160c205..613a9662ace 100644 --- a/docs/tutorials/google/visualizing_calibration_metrics.ipynb +++ b/docs/tutorials/google/visualizing_calibration_metrics.ipynb @@ -53,10 +53,10 @@ " View on QuantumAI\n", " \n", " \n", - " Run in Google Colab\n", + " Run in Google Colab\n", " \n", " \n", - " View source on GitHub\n", + " View source on GitHub\n", " \n", " \n", " Download notebook\n", @@ -111,7 +111,7 @@ "1. Enter the Cloud project ID you'd like to use in the `YOUR_PROJECT_ID` field.\n", "2. Then run the cell below (and go through the auth flow for access to the project id you entered).\n", "\n", - "\"Quantum" + "\"Quantum" ] }, { diff --git a/release.md b/release.md index 4bc3803d671..1b98b1973a2 100644 --- a/release.md +++ b/release.md @@ -1,11 +1,11 @@ # Versioning and Releases Below is info on how we version releases, and how the releases -themselves are created. Note that development is done on the `master` +themselves are created. Note that development is done on the `main` branch, so if you want to use a more stable version you should use one of the [releases](https://github.com/quantumlib/Cirq/releases) or install from pypi using `pip install cirq`. The release from the -latest commit to master can be installed with `pip install --pre cirq`. +latest commit to main can be installed with `pip install --pre cirq`. ## Versioning @@ -39,7 +39,7 @@ is a numerical value. The following guarantees are provided: changes to its public API. 2. For each vendor directory, version policies may be modified to strictly follow Semantic Versioning in the future. -5. Versions based on unreleased branches of master will be suffixed with ".dev". +5. Versions based on unreleased branches of main will be suffixed with ".dev". The rules for version changes are: * Increment the PATCH version if all changes are bug fixes only. @@ -57,10 +57,10 @@ directories that prohibit them for a minor version increment. We use github's release system for creating releases. Release are listed [on the Cirq release page](https://github.com/quantumlib/Cirq/releases). -Our development process uses the `master` branch for development. +Our development process uses the `main` branch for development. Master will always use the next unreleased minor version with the suffix of ".dev". When a release is performed, the ".dev" will be removed and tagged -in a release branch with a version tag (vX.X.X). Then, master will be updated +in a release branch with a version tag (vX.X.X). Then, main will be updated to the next minor version. This can always be found in the [version file](./cirq-core/cirq/_version.py). @@ -84,12 +84,12 @@ release. System requirements: Linux, python3.9 -For MINOR / MAJOR release: Make sure you're on an up-to-date master branch and +For MINOR / MAJOR release: Make sure you're on an up-to-date main branch and in cirq's root directory. ```bash -git checkout master -git pull origin master # or upstream master +git checkout main +git pull origin main # or upstream main git status # should be no pending changes ``` @@ -145,13 +145,13 @@ git commit -m "Removing ${VER}.dev -> ${VER}" git push origin "v${VER}-dev" ``` -### Bump the master version +### Bump the main version -WARNING: Only bump the master version for minor and major releases, for PATCH +WARNING: Only bump the main version for minor and major releases, for PATCH updates, leave it as it is. ```bash -git checkout master -b "version_bump_${NEXT_VER}" +git checkout main -b "version_bump_${NEXT_VER}" python dev_tools/modules.py replace_version --old ${VER}.dev --new ${NEXT_VER}.dev git add . git commit -m "Bump cirq version to ${NEXT_VER}"