Restructure file relocation (quantumlib#5442)

1. Move files into the directories which represent the tabs they are indexed with.
2. Fix the indices to point to the new locations
3. Fix links across all pages to point to the new locations
4. Fix some other links to make them absolute instead of relative.  

This should only be merged with the CL that has redirects for everything moved: cl/452987763.

.github/CODEOWNERS

@@ -37,22 +37,17 @@ docs/**/*.* @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
 docs/google/**/*.* @wcourtney @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult
 docs/tutorials/google/**/*.* @wcourtney @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck @verult
 
-docs/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @aasfaw @rmlarose @Cynocracy @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @aasfaw @rmlarose @Cynocracy @quantumlib/cirq-maintainers @vtomole @cduck
+docs/hardware/ionq/**/*.* @dabacon @ColemanCollins @nakardo @gmauricio @aasfaw @rmlarose @Cynocracy @quantumlib/cirq-maintainers @vtomole @cduck
 
-docs/aqt/**/*.* @ma5x @pschindler @alfrisch @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/aqt/**/*.* @ma5x @pschindler @alfrisch @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/hardware/aqt/**/*.* @ma5x @pschindler @alfrisch @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
 
-docs/pasqal/**/*.* @HGSilveri @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/pasqal/**/*.* @HGSilveri @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/hardware/pasqal/**/*.* @HGSilveri @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
 
-docs/rigetti/**/*.* @erichulburd @kalzoo @dbanty @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/rigetti/**/*.* @erichulburd @kalzoo @dbanty @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
+docs/hardware/rigetti/**/*.* @erichulburd @kalzoo @dbanty @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
 
-docs/azure-quantum/**/*.* @guenp @anpaz @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
-docs/tutorials/azure-quantum/**/*.* @guenp @anpaz @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
+docs/hardware/azure-quantum/**/*.* @guenp @anpaz @aasfaw @quantumlib/cirq-maintainers @vtomole @cduck
 
 #############################################################
 # qcvv docs maintainers: docs maintainers + mrwojtek + aasfaw
 #############################################################
-docs/qcvv/**/*.* @mrwojtek @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck
+docs/noise/qcvv/**/*.* @mrwojtek @aasfaw @rmlarose @quantumlib/cirq-maintainers @vtomole @cduck

dev_tools/codeowners_test.py

@@ -53,22 +53,22 @@
         ("docs/_book.yaml", DOCS_MAINTAINERS),
         # qcvv
         ("cirq-core/cirq/experiments/__init__.py", QCVV_MAINTAINERS),
-        ("docs/qcvv/isolated_xeb.ipynb", QCVV_MAINTAINERS.union(DOCS_MAINTAINERS)),
+        ("docs/noise/qcvv/isolated_xeb.ipynb", QCVV_MAINTAINERS.union(DOCS_MAINTAINERS)),
         # aqt
         ("cirq-aqt/cirq_aqt/__init__.py", AQT_MAINTAINERS),
         ("cirq-aqt/setup.py", AQT_MAINTAINERS),
-        ("docs/aqt/access.md", AQT_MAINTAINERS.union(DOCS_MAINTAINERS)),
-        ("docs/tutorials/aqt/getting_started.ipynb", AQT_MAINTAINERS.union(DOCS_MAINTAINERS)),
+        ("docs/hardware/aqt/access.md", AQT_MAINTAINERS.union(DOCS_MAINTAINERS)),
+        ("docs/hardware/aqt/getting_started.ipynb", AQT_MAINTAINERS.union(DOCS_MAINTAINERS)),
         # pasqal
         ("cirq-pasqal/cirq_pasqal/__init__.py", PASQAL_MAINTAINERS),
         ("cirq-pasqal/setup.py", PASQAL_MAINTAINERS),
-        ("docs/pasqal/access.md", PASQAL_MAINTAINERS.union(DOCS_MAINTAINERS)),
-        ("docs/tutorials/pasqal/getting_started.ipynb", PASQAL_MAINTAINERS.union(DOCS_MAINTAINERS)),
+        ("docs/hardware/pasqal/access.md", PASQAL_MAINTAINERS.union(DOCS_MAINTAINERS)),
+        ("docs/hardware/pasqal/getting_started.ipynb", PASQAL_MAINTAINERS.union(DOCS_MAINTAINERS)),
         # ionq
         ("cirq-ionq/cirq_ionq/__init__.py", IONQ_MAINTAINERS),
         ("cirq-ionq/setup.py", IONQ_MAINTAINERS),
-        ("docs/ionq/access.md", IONQ_MAINTAINERS.union(DOCS_MAINTAINERS)),
-        ("docs/tutorials/ionq/getting_started.ipynb", IONQ_MAINTAINERS.union(DOCS_MAINTAINERS)),
+        ("docs/hardware/ionq/access.md", IONQ_MAINTAINERS.union(DOCS_MAINTAINERS)),
+        ("docs/hardware/ionq/getting_started.ipynb", IONQ_MAINTAINERS.union(DOCS_MAINTAINERS)),
         # google
         ("cirq-google/cirq_google/__init__.py", GOOGLE_MAINTAINERS),
         ("cirq-google/setup.py", GOOGLE_MAINTAINERS),

dev_tools/notebooks/isolated_notebook_test.py

@@ -44,17 +44,17 @@
     # Hardcoded qubit placement
     'docs/google/qubit-placement.ipynb',
     # get_qcs_objects_for_notebook
-    'docs/tutorials/google/calibration_api.ipynb',
+    'docs/noise/calibration_api.ipynb',
     'docs/tutorials/google/colab.ipynb',
     'docs/tutorials/google/identifying_hardware_changes.ipynb',
     'docs/tutorials/google/echoes.ipynb',
-    'docs/tutorials/google/floquet_calibration_example.ipynb',
+    'docs/noise/floquet_calibration_example.ipynb',
     'docs/tutorials/google/spin_echoes.ipynb',
     'docs/tutorials/google/start.ipynb',
     'docs/tutorials/google/visualizing_calibration_metrics.ipynb',
-    'docs/tutorials/google/xeb_calibration_example.ipynb',
+    'docs/noise/qcvv/xeb_calibration_example.ipynb',
     'docs/named_topologies.ipynb',
-    'docs/tutorials/educators/intro.ipynb',
+    'docs/start/intro.ipynb',
 ]
 
 # By default all notebooks should be tested, however, this list contains exceptions to the rule

dev_tools/notebooks/notebook_test.py

@@ -37,7 +37,10 @@
     # skipping fidelity estimation due to
     # https://github.com/quantumlib/Cirq/issues/3502
     "examples/*fidelity*",
-    'docs/noise.ipynb',
+    # tutorials that use QCS and arent skipped due to one or more cleared output cells
+    'docs/noise/qcvv/xeb_calibration_example.ipynb',
+    'docs/noise/calibration_api.ipynb',
+    'docs/noise/floquet_calibration_example.ipynb',
 ]
 
 

docs/_book.yaml

@@ -32,16 +32,16 @@ upper_tabs:
       ####  FIRST STEPS  ####
       - heading: "First steps"
       - title: "Install"
-        path: /cirq/install
+        path: /cirq/start/install
       - title: "Hello Qubit Example"
-        path: /cirq/start
+        path: /cirq/start/start
       - title: "Cirq Basics"
-        path: /cirq/tutorials/basics
+        path: /cirq/start/basics
 
       ####  TEST UNDERSTANDING  ####
       - heading: "Test understanding"
       - title: "Cirq Intro Workshop"
-        path: /cirq/tutorials/educators/intro
+        path: /cirq/start/intro
 
     - name: "Build"
       contents:
@@ -50,45 +50,45 @@ upper_tabs:
       ####  CIRCUIT CONSTRUCTION  ####
       - heading: "Circuit construction"
       - title: "Circuits"
-        path: /cirq/circuits
+        path: /cirq/build/circuits
       - title: "Qubits"
-        path: /cirq/qubits
+        path: /cirq/build/qubits
       - title: "Gates and operations"
-        path: /cirq/gates
+        path: /cirq/build/gates
       - title: "Custom gates"
-        path: /cirq/custom_gates
+        path: /cirq/build/custom_gates
       - title: "Import/export circuits"
-        path: /cirq/interop
+        path: /cirq/build/interop
       ####   ADVANCED  ####
       - heading: "Advanced"
       - title: "Operators"
-        path: /cirq/operators
+        path: /cirq/build/operators
       - title: "Qudits"
-        path: /cirq/qudits
+        path: /cirq/build/qudits
       - title: "Protocols"
-        path: /cirq/protocols
+        path: /cirq/build/protocols
       - title: "Tools Ecosystem"
-        path: /cirq/ecosystem
+        path: /cirq/build/ecosystem
 
     - name: "Simulate"
       contents:
       - title: "Overview"
         path: /cirq/simulate
       - title: "Exact Simulation"
-        path: /cirq/simulation
+        path: /cirq/simulate/simulation
       - title: "Noisy Simulation"
-        path: /cirq/noisy_simulation
+        path: /cirq/simulate/noisy_simulation
       - title: "Parameter Sweeps"
-        path: /cirq/params
+        path: /cirq/simulate/params
       - title: "State Histograms"
-        path: /cirq/tutorials/state_histograms
+        path: /cirq/simulate/state_histograms
 
     - name: "Transform"
       contents:
       - title: "Overview"
         path: /cirq/transform
       - title: "Circuit Transformers"
-        path: /cirq/transformers
+        path: /cirq/transform/transformers
       - title: "Custom Transformers"
         path: /cirq/transform/custom_transformers
 
@@ -97,102 +97,100 @@ upper_tabs:
       - title: "Overview"
         path: /cirq/hardware
       - title: "Devices"
-        path: /cirq/devices
+        path: /cirq/hardware/devices
 
       ####  AQT  ####
       - heading: "AQT hardware"
       - title: "Access and authentication"
-        path: /cirq/aqt/access
+        path: /cirq/hardware/aqt/access
       - title: "Getting started with AQT hardware"
-        path: /cirq/tutorials/aqt/getting_started
+        path: /cirq/hardware/aqt/getting_started
 
       #### Azure Quantum ####
       - heading: "Azure Quantum"
       - title: "Access and authentication"
-        path: /cirq/azure-quantum/access
+        path: /cirq/hardware/azure-quantum/access
       - title: "Getting started with Honeywell on Azure Quantum"
-        path: /cirq/tutorials/azure-quantum/getting_started_honeywell
+        path: /cirq/hardware/azure-quantum/getting_started_honeywell
       - title: "Getting started with IonQ on Azure Quantum"
-        path: /cirq/tutorials/azure-quantum/getting_started_ionq
+        path: /cirq/hardware/azure-quantum/getting_started_ionq
 
       ##### IonQ ####
       - heading: "IonQ hardware"
       - title: "Access and authentication"
-        path: /cirq/ionq/access
+        path: /cirq/hardware/ionq/access
       - title: "Getting started with IonQ hardware"
-        path: /cirq/tutorials/ionq/getting_started
+        path: /cirq/hardware/ionq/getting_started
       - title: "IonQ API service"
-        path: /cirq/ionq/service
+        path: /cirq/hardware/ionq/service
       - title: "IonQ API circuits"
-        path: /cirq/ionq/circuits
+        path: /cirq/hardware/ionq/circuits
       - title: "Running IonQ API jobs"
-        path: /cirq/ionq/jobs
+        path: /cirq/hardware/ionq/jobs
       - title: "IonQ API calibrations"
-        path: /cirq/ionq/calibrations
+        path: /cirq/hardware/ionq/calibrations
 
       ####  PASQAL  ####
       - heading: "Pasqal hardware"
       - title: "Access and authentication"
-        path: /cirq/pasqal/access
+        path: /cirq/hardware/pasqal/access
       - title: "Getting started with Pasqal hardware"
-        path: /cirq/tutorials/pasqal/getting_started
+        path: /cirq/hardware/pasqal/getting_started
       - title: "Pasqal devices"
-        path: /cirq/pasqal/devices
+        path: /cirq/hardware/pasqal/devices
       - title: "Pasqal sampler"
-        path: /cirq/pasqal/sampler
+        path: /cirq/hardware/pasqal/sampler
 
       ##### RIGETTI ####
       - heading: "Rigetti hardware"
       - title: "Access and authentication"
-        path: /cirq/rigetti/access
+        path: /cirq/hardware/rigetti/access
       - title: "Getting started with Rigetti hardware"
-        path: /cirq/tutorials/rigetti/getting_started
+        path: /cirq/hardware/rigetti/getting_started
 
     - name: "Noise"
       contents:
       - title: "Overview"
         path: /cirq/noise
       ####  CHARACTERIZATION AND COMPENSATION  ####
       - heading: "Characterization and compensation"
-      - title: "Calibration: Overview and API"
-        path: /cirq/tutorials/google/calibration_api
+      - title: "Calibration FAQ"
+        path: /cirq/noise/calibration_faq
       - title: "Floquet Calibration"
-        path: /cirq/tutorials/google/floquet_calibration_example
+        path: /cirq/noise/floquet_calibration_example
       - title: "Cross Entropy Benchmarking (XEB)"
         style: accordion
         section:
         - title: "Cross Entropy Benchmarking Theory"
-          path: /cirq/qcvv/xeb_theory
+          path: /cirq/noise/qcvv/xeb_theory
         - title: "XEB and coherent error"
-          path: /cirq/qcvv/xeb_coherent_noise
+          path: /cirq/noise/qcvv/xeb_coherent_noise
         - title: "Parallel XEB"
-          path: /cirq/qcvv/parallel_xeb
+          path: /cirq/noise/qcvv/parallel_xeb
         - title: "XEB calibration: Example and Benchmark"
-          path: /cirq/tutorials/google/xeb_calibration_example
-      - title: "Calibration FAQ"
-        path: /cirq/google/calibration_faq
+          path: /cirq/noise/qcvv/xeb_calibration_example
       ####  VISUALIZING NOISE  ####
       - heading: "Visualizing noise"
       - title: "Heatmaps"
-        path: /cirq/tutorials/heatmaps
+        path: /cirq/noise/heatmaps
 
     - name: "Experiments"
       contents:
       - title: "Overview"
         path: /cirq/experiments
       - heading: "Algorithms in Cirq"
       - title: "Textbook Algorithms Workshop"
-        path: /cirq/tutorials/educators/textbook_algorithms
+        path: /cirq/experiments/textbook_algorithms
       - title: "Shor's Algorithm"
-        path: /cirq/tutorials/shor
+        path: /cirq/experiments/shor
       - title: "Variational Quantum Eigensolver"
-        path: /cirq/tutorials/variational_algorithm
+        path: /cirq/experiments/variational_algorithm
       - title: "Quantum Walks"
-        path: /cirq/tutorials/quantum_walks
+        path: /cirq/experiments/quantum_walks
       - title: "Fourier Checking"
-        path: /cirq/tutorials/fourier_checking
+        path: /cirq/experiments/fourier_checking
       - title: "Hidden Linear Function problem"
-        path: /cirq/tutorials/hidden_linear_function
+        path: /cirq/experiments/hidden_linear_function
       - heading: "Algorithms in ReCirq"
       - include: /cirq/experiments/_toc.yaml
 
@@ -221,7 +219,7 @@ upper_tabs:
       - title: "Triage process"
         path: /cirq/dev/triage
       - title: "Issues / requests / questions"
-        path: /cirq/support
+        path: /cirq/dev/support
 
     - name: "Reference"
       skip_translation: true

docs/build/_index.yaml

@@ -13,19 +13,19 @@ landing_page:
       items:
       - heading: Circuits
         description: Quantum circuits and how to create them.
-        path: /cirq/circuits
+        path: /cirq/build/circuits
       - heading: Qubits
         description: The quantum bit data structure.
-        path: /cirq/qubits
+        path: /cirq/build/qubits
       - heading: Gates and Operations
         description: Quantum gates to apply to qubits in a circuit.
-        path: /cirq/gates
+        path: /cirq/build/gates
       - heading: Custom gates
         description: Create your own gates with unitaries or decomposition.
-        path: /cirq/custom_gates
+        path: /cirq/build/custom_gates
       - heading: Import/export circuits
         description: Importing or exporting circuits into/out of Cirq.
-        path: /cirq/interop
+        path: /cirq/build/interop
 
     - heading: Advanced construction
       description: More elaborate ways to build quantum circuits.
@@ -34,13 +34,13 @@ landing_page:
       items:
       - heading: Operators
         description: Unitary operators, measurements and noise channels.
-        path: /cirq/operators
+        path: /cirq/build/operators
       - heading: Qudits
         description: Qutrits and higher dimensional quantum systems.
-        path: /cirq/qudits
+        path: /cirq/build/qudits
       - heading: Protocols
         description: Magic methods supported by Cirq's classes.
-        path: /cirq/protocols
+        path: /cirq/build/protocols
       - heading: Tools ecosystem
         description: External tools for circuit construction.
-        path: /cirq/ecosystem
+        path: /cirq/build/ecosystem

docs/circuits.ipynb → docs/build/circuits.ipynb

@@ -40,16 +40,16 @@
    "source": [
     "<table class=\"tfo-notebook-buttons\" align=\"left\">\n",
     "  <td>\n",
-    "    <a target=\"_blank\" href=\"https://quantumai.google/cirq/circuits\"><img src=\"https://quantumai.google/site-assets/images/buttons/quantumai_logo_1x.png\" />View on QuantumAI</a>\n",
+    "    <a target=\"_blank\" href=\"https://quantumai.google/cirq/build/circuits\"><img src=\"https://quantumai.google/site-assets/images/buttons/quantumai_logo_1x.png\" />View on QuantumAI</a>\n",
     "  </td>\n",
     "  <td>\n",
-    "    <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/docs/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
+    "    <a target=\"_blank\" href=\"https://colab.research.google.com/github/quantumlib/Cirq/blob/master/docs/build/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/colab_logo_1x.png\" />Run in Google Colab</a>\n",
     "  </td>\n",
     "  <td>\n",
-    "    <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/docs/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
+    "    <a target=\"_blank\" href=\"https://github.com/quantumlib/Cirq/blob/master/docs/build/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/github_logo_1x.png\" />View source on GitHub</a>\n",
     "  </td>\n",
     "  <td>\n",
-    "    <a href=\"https://storage.googleapis.com/tensorflow_docs/Cirq/docs/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/download_icon_1x.png\" />Download notebook</a>\n",
+    "    <a href=\"https://storage.googleapis.com/tensorflow_docs/Cirq/docs/build/circuits.ipynb\"><img src=\"https://quantumai.google/site-assets/images/buttons/download_icon_1x.png\" />Download notebook</a>\n",
     "  </td>\n",
     "</table>"
    ]
@@ -756,8 +756,8 @@
     "- [Operators](operators.ipynb) - more complicated structures to put in circuits\n",
     "\n",
     "Once you've built your circuit, read these to learn what you can do with it: \n",
-    "- [Simulation](simulation.ipynb) - run your circuit on the Cirq simulator to see what it does\n",
-    "- [Transform circuits](transformers.ipynb) - run transformer functions to change your circuit in different ways\n",
+    "- [Simulation](/cirq/simulate/simulation.ipynb) - run your circuit on the Cirq simulator to see what it does\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",
     "- [Import/export circuits](interop.ipynb) - features to serialize/deserialize circuits into/from different formats"