Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add QVM pages and mentions in other pages #5794

Merged
merged 16 commits into from
Jul 19, 2022
Merged
2 changes: 2 additions & 0 deletions dev_tools/notebooks/isolated_notebook_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@
"examples/*fidelity*",
# Also skipping stabilizer code testing.
"examples/*stabilizer_code*",
# An intentionally empty/template code notebook.
"docs/simulate/qvm_builder_code.ipynb",
*NOTEBOOKS_DEPENDING_ON_UNRELEASED_FEATURES,
]

Expand Down
1 change: 1 addition & 0 deletions dev_tools/notebooks/notebook_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
'docs/noise/qcvv/xeb_calibration_example.ipynb',
'docs/noise/calibration_api.ipynb',
'docs/noise/floquet_calibration_example.ipynb',
'docs/simulate/qvm_builder_code.ipynb',
]


Expand Down
14 changes: 14 additions & 0 deletions docs/_book.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,18 @@ upper_tabs:
- title: "Observables and PauliStrings"
path: /cirq/simulate/pauli_observables

- heading: "Quantum Virtual Machine"
- title: "Quantum Virtual Machine"
path: /cirq/simulate/quantum_virtual_machine
- title: "QVM Creation Template"
path: /cirq/simulate/qvm_builder_code
- title: "QVM Basic Example"
path: /cirq/simulate/qvm_basic_example
- title: "QVM Stabilizer Example"
path: /cirq/simulate/qvm_stabilizer_example
- title: "Virtual Engine Interface"
path: /cirq/simulate/virtual_engine_interface

- name: "Transform"
contents:
- title: "Overview"
Expand All @@ -102,6 +114,8 @@ upper_tabs:
path: /cirq/hardware
- title: "Devices"
path: /cirq/hardware/devices
- title: "Qubit Picking"
path: /cirq/hardware/qubit_picking

#### AQT ####
- heading: "AQT hardware"
Expand Down
13 changes: 11 additions & 2 deletions docs/build/circuits.ipynb
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {
"id": "DkA0Fobtb9dM"
},
"source": [
"##### Copyright 2022 The Cirq Developers"
]
},
{
"cell_type": "code",
"execution_count": null,
Expand All @@ -9,8 +18,7 @@
},
"outputs": [],
"source": [
"# @title Copyright 2020 The Cirq Developers\n",
"# Licensed under the Apache License, Version 2.0 (the \"License\");\n",
"# @title Licensed under the Apache License, Version 2.0 (the \"License\");\n",
"# you may not use this file except in compliance with the License.\n",
"# You may obtain a copy of the License at\n",
"#\n",
Expand Down Expand Up @@ -757,6 +765,7 @@
"\n",
"Once you've built your circuit, read these to learn what you can do with it: \n",
"- [Simulation](/cirq/simulate/simulation.ipynb) - run your circuit on the Cirq simulator to see what it does\n",
"- [Quantum Virtual Machine](/cirq/simulate/quantum_virtual_machine) - run your circuit on a specialized simulator that mimics actual quantum hardware, including noise.\n",
"- [Transform circuits](/cirq/transform/transformers.ipynb) - run transformer functions to change your circuit in different ways\n",
"\n",
"If you need to import or export circuits into or out of Cirq, see: \n",
Expand Down
6 changes: 6 additions & 0 deletions docs/hardware/_index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ landing_page:

- heading: Run a circuit on a hardware device
description: Cirq provides interfaces for running your circuits on quantum hardware provided by many different services.
options:
- cards
items:
- heading: Qubit Picking
description: Information to help you pick good qubits for running your circuit on a hardware or hardware-like device.
path: /cirq/hardware/qubit_picking

- heading: AQT hardware
description: Cirq's interface with Alpine Quantum Technologies hardware.
Expand Down
13 changes: 13 additions & 0 deletions docs/hardware/devices.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -466,6 +466,19 @@
"nx.draw(my_metadata.nx_graph)"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "ddabb2b0bcc3"
},
"source": [
"## Use in a virtual Engine\n",
"\n",
"`Device`s can also be used to specify `cirq.SimulatedLocalEngine` instances, which let you validate and simulate circuits using the same interface that the quantum hardware does. Read more in the [Virtual Engine Interface](/cirq/simulate/virtual_engine_interface) page. \n",
"\n",
"Additionally, these virtual `Engine`s can be combined with noisy simulation that attempts to mimic existing hardware devices with the [Quantum Virtual Machine](/cirq/simulate/quantum_virtual_machine). "
]
},
{
"cell_type": "markdown",
"metadata": {
Expand Down
Loading