New landing page for tutorials (#3506)

Cosmetic changes to the tutorial landing page, keeping a similar structure (beginner / intermediate / advanced) to the old `index.md`. One could argue some advanced tutorials should be under the intermediate section (e.g., Rabi oscillation seems more intermediate to me) and vice versa, but these are easy changes once the structure is in place. Tutorials hosted on GitHub are marked with a GitHub icon.
quantumlib · Nov 17, 2020 · 956845e · 956845e
1 parent 7d73750
commit 956845e
Show file tree

Hide file tree

Showing 4 changed files with 138 additions and 123 deletions.
diff --git a/docs/tutorials/_index.yaml b/docs/tutorials/_index.yaml
@@ -0,0 +1,137 @@
+book_path: /cirq/_book.yaml
+project_path: /cirq/_project.yaml
+title: Tutorials
+landing_page:
+  nav: left
+  rows:
+    - items:
+      - description: >
+            Cirq comes with a collection of example implementations of beginner,
+            intermediate, and advanced quantum algorithms that demonstrate the
+            main features of the library.
+    - heading: Beginner
+      description: Explore Cirq through introductory quantum information examples.
+      items:
+      - heading: Hello Qubit
+        description: Simple first program showing how to create a quantum circuit.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/hello_qubit.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Deutsch's Algorithm
+        description: Textbook example of the simplest quantum advantage.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/deutsch.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Bernstein-Vazirani Algorithm
+        description: Textbook algorithm determining a global property of a function with surprisingly few calls to it.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/bernstein_vazirani.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+
+      - heading: Bell Inequality
+        description: Demonstration of a Bell inequality which shows impossibility of local hidden variable theories.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/bell_inequality.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: BB84
+        description: Textbook algorithm for Quantum Key Distribution.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/bb84.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Noisy Simulation
+        description: How to use a noisy simulator to execute quantum circuits.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/noisy_simulation_example.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+
+      - heading: Qubit Placement
+        description: How to find a line of adjacent qubits on a device.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/place_on_bristlecone.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Quantum Teleportation
+        description: A demonstration of using 2 classical bits to transport a quantum state from one
+          qubit to another.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/quantum_teleportation.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Superdense Coding
+        description: Transmit 2 classical bits using one quantum bit.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/superdense_coding.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+
+    - heading: Intermediate
+      description: Use Cirq for intermediate-level subroutines and algorithms.
+      items:
+      - heading: Arithmetic
+        description: Algorithms for adding and multiplying numbers represented by quantum states.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/basic_arithmetic.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Grover's Algorithm
+        description: Use a quantum computer to find a needle in a haystack.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/grover.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Shor's Code
+        description: Quantum error correction with Shor's nine-qubit code.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/shors_code.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+
+      - heading: Quantum Fourier Transform
+        description: Change from the computational basis to the frequency basis and vice versa.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/quantum_fourier_transform.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Phase Estimation
+        description: Find the eigenvalues of a unitary operator.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/phase_estimator.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Shor's Algorithm
+        description: Factor numbers using a quantum computer.
+        path: /cirq/tutorials/shor
+
+      - heading: Swap Networks
+        description: Algorithm for efficiently emulating full connectivity on a limited connectivity grid of qubits.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/swap_networks.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Direct Fidelity
+        description: Direct fidelity estimation to distinguish a desired state fromt he actual state using few Pauli measurements.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/direct_fidelity_estimation.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: XEB
+        description: Fidelity estimation using cross-entropy benchmarking (XEB).
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/cross_entropy_benchmarking_example.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+
+
+    - heading: Advanced
+      description: Utilize Cirq features to implement advanced quantum algorithms.
+      items:
+      - heading: Quantum Variational Algorithm
+        description: Use the variational quantum eigensolver to find the ground state of the Ising model.
+        path: /cirq/tutorials/variational_algorithm
+      - heading: Approximate Optimization
+        description: Use a quantum computer to find approximately optimal cuts in a graph.
+        path: /cirq/tutorials/qaoa
+      - heading: Hidden Linear Function
+        description: Find a hidden vector with a constant depth quantum circuit.
+        path: /cirq/tutorials/hidden_linear_function
+
+      - heading: Quantum Walks
+        description: Demonstration of classical and quantum random walks on a graph.
+        path: /cirq/tutorials/quantum_walks
+      - heading: HHL
+        description: Algorithm for solving linear systems using quantum phase estimation.
+        path: https://github.com/quantumlib/Cirq/blob/master/examples/hhl.py
+        icon:
+          path: /site-assets/images/cards/github-card-16x9.png
+      - heading: Rabi Oscillation
+        description: Example of using sweeps and symbols to show rotation of a qubit by different angles.
+        path: /cirq/tutorials/rabi_oscillations
diff --git a/docs/tutorials/basics.ipynb b/docs/tutorials/basics.ipynb
@@ -743,7 +743,7 @@
     "* Learn about the variety of [Gates](../gates.ipynb) available in cirq and more about the different ways to construct [Circuits](../circuits.ipynb)\n",
     "* Learn more about [Simulations](../simulation.ipynb) and how it works.\n",
     "* Learn about [Noise](../noise.ipynb) and how to utilize multi-level systems using [Qudits](../qudits.ipynb)\n",
-    "* Dive into some [Examples](index.md) and some in-depth tutorials of how to use cirq.\n",
+    "* Dive into some [Examples](_index.yaml) and some in-depth tutorials of how to use cirq.\n",
     "\n",
     "Also, join our [cirq-announce mailing list](https://groups.google.com/forum/#!forum/cirq-announce) to hear about changes and releases or go to the [cirq github](https://github.com/quantumlib/Cirq/) to file issues."
    ]

diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md
diff --git a/rtd_docs/index.rst b/rtd_docs/index.rst
@@ -57,7 +57,6 @@ User Documentation
     :maxdepth: 1
     :caption: Tutorials
 
-    docs/tutorials/index
     docs/tutorials/shor.ipynb
     docs/tutorials/variational_algorithm.ipynb
     docs/tutorials/qaoa.ipynb