KolCrooks / QuantumKatas

Tutorials and programming exercises for learning Q# and quantum computing

Introduction

The Quantum Katas are a series of self-paced tutorials to help you learn quantum computing and Q# programming.

🆕 (July 2019) The Quantum Katas now include Jupyter Notebook tutorials on quantum computing! Each tutorial combines theoretical explanations with Q# code snippets and programming exercises. See index.ipynb for the list of all tutorials and instructions on running them online.

🆕 (April 2019) The Quantum Katas are now available as Jupyter Notebooks! See index.ipynb for the list of all Kata Notebooks and instructions on running them online.

Each kata is a separate project that includes:

• A sequence of tasks progressing from easy to hard. Each task requires you to fill in some code. The first task might require just one line, and the last one might require rather complicated code.
• A testing framework that sets up, runs, and validates your solutions. Each task is covered by a unit test which initially fails. Once you write the code to make the test pass, you can move on to the next task.
• Links to quantum computing and Q# reference material you might need to solve the tasks.
• Hints and reference solutions to help you if you're stuck.

Table of contents

• List of tutorials
• List of katas
• Run the katas and tutorials online
• Run the katas locally
  • Download the Quantum Katas
  • Run a kata as a Q# project
  • Run kata tests
  • Run katas locally with Docker
• Contributing
• Code of Conduct

List of tutorials

• Complex arithmetic. Learn about complex numbers and the mathematics required to work with quantum computing.
• Linear algebra. Learn about vectors and matrices used to represent quantum states and quantum operations.
• The qubit. Learn what a qubit is.
• Single-qubit gates. Learn what a quantum gate is and about the most common single-qubit gates.
• Multi-qubit systems. Learn to represent multi-qubit systems.
• Multi-qubit gates. Learn about the most common multi-qubit gates.
• Exploring Deutsch–Jozsa algorithm. Learn to implement classical functions and equivalent quantum oracles, and compare the quantum solution to the Deutsch–Jozsa problem to a classical one.
• Exploring Grover's search algorithm. Learn more about Grover's search algorithm, picking up where the Grover's algorithm kata left off.

List of Katas

Quantum computing concepts

• Basic quantum computing gates. Learn to apply the most common gates used in quantum computing.
• Superposition. Learn to prepare superposition states.
• Measurements. Learn to distinguish quantum states using measurements.
• Joint measurements. Learn about using joint (parity) measurements to distinguish quantum states and to perform state transformations.

Simple algorithms

• Teleportation. Implement standard teleportation protocol and its variations.
• Superdense coding. Implement the superdense coding protocol.
• Deutsch–Jozsa algorithm. Learn about quantum oracles which implement classical functions, and implement Bernstein–Vazirani and Deutsch–Jozsa algorithms.
• Simon's algorithm. Learn about Simon's algorithm.

Grover's algorithm

• Grover's algorithm. Learn about Grover's search algorithm and how to write quantum oracles to use with it.
• Solving SAT problems using Grover's algorithm. Explore Grover's search algorithm, using SAT problems as an example. Learn to implement quantum oracles based on the problem description instead of a hard-coded answer. Use Grover's algorithm to solve problems with an unknown number of solutions.
• Solving graph coloring problems using Grover's algorithm. Continue the exploration of Grover's search algorithm, using graph coloring problems as an example.

Entanglement games

• CHSH game.
• GHZ game.
• Mermin-Peres magic square game.

Miscellaneous

• BB84 protocol. Implement the BB84 key distribution algorithm.
• Phase estimation. Learn about phase estimation algorithms.
• Bit-flip error correcting code. Learn about a 3-qubit error correcting code for protecting against bit-flip errors.
• Ripple-carry adder. Build a ripple-carry adder on a quantum computer.
• Unitary Patterns*. Learn to implement unitaries with matrices that follow certain patterns of zero and non-zero elements.

Run the katas and tutorials online

The Quantum Katas are now available as Jupyter Notebooks! See index.ipynb for the list of all katas and tutorials, and instructions to run them online.

Run katas locally

To use the Quantum Katas locally, you'll need the Quantum Development Kit, available for Windows 10, macOS, and Linux. If you don't already have the Quantum Development Kit installed, see install guide for the Quantum Development Kit.

For a quick Q# programming language reference sheet, see Q# Language Quick Reference.

Download the Quantum Katas

If you have Git installed, clone the Microsoft/QuantumKatas repository:

$ git clone https://github.com/Microsoft/QuantumKatas.git

Tip

Both Visual Studio 2019 and Visual Studio Code make it easy to clone repositories from within your development environment. For details, see the Visual Studio 2019 and Visual Studio Code documentation.

If you don't have Git installed, download the katas from https://github.com/Microsoft/QuantumKatas/archive/master.zip.

Run a kata as a Q# project

Each kata is in its own directory as a self-contained Q# project, solution and Jupyter Notebook triplet. For instance, the BasicGates directory structure is:

QuantumKatas/
  BasicGates/
    README.md                  # Instructions specific to this kata.
    .vscode/                   # Metadata used by Visual Studio Code.
    BasicGates.sln             # Visual Studio 2019 solution file.
    BasicGates.csproj          # Project file used to build both classical and quantum code.
    BasicGates.ipynb           # Jupyter Notebook front-end for this kata.

    Tasks.qs                   # Q# source code that you will fill as you solve each task.
    Tests.qs                   # Q# tests that verify your solutions.
    TestSuiteRunner.cs         # C# source code used to run the Q# tests.
    ReferenceImplementation.qs # Q# source code containing solutions to the tasks.

To open the BasicGates kata in Visual Studio 2019, open the QuantumKatas/BasicGates/BasicGates.sln solution file.

To open the BasicGates kata in Visual Studio Code, open the QuantumKatas/BasicGates/ folder. Press Ctrl + Shift + P (or ⌘ + Shift + P on macOS) to open the Command Palette. Type Open Folder on Windows 10 or Linux or Open on macOS.

Tip

Almost all commands available in Visual Studio Code are in the Command Palette. If you get stuck, press Ctrl + Shift + P (or ⌘ + Shift + P on macOS) and start typing to search through all available commands.

You can also launch Visual Studio Code from the command line:

$ code QuantumKatas/BasicGates/

Run kata tests

Once you have a kata open, it's time to run the tests using the following instructions. Initially all tests will fail. Don't panic! Open Tasks.qs and start filling in the code to complete the tasks. Each task is covered by a unit test. Once you fill in the correct code for a task, rebuild the project and re-run the tests, and the corresponding unit test will pass.

Visual Studio 2019

1. Build the solution.
2. From the main menu, open Test Explorer (Test > Windows) and select Run All to run all unit tests at once.
3. Work on the tasks in the Tasks.qs file.
4. To test your code changes for a task, rebuild the solution and re-run all unit tests using Run All, or run just the test for that task by right-clicking the test and selecting Run Selected Tests.

Visual Studio Code

1. Press Ctrl + ` (or ⌘ + ` on macOS) to open the integrated terminal. The terminal should open to the kata directory. If it doesn't, navigate to the folder containing the *.csproj file for the kata using cd command.
2. Run dotnet test in the integrated terminal. This should build the kata project and run all of the unit tests. All of the unit tests should fail.
3. Work on the tasks in the Tasks.qs file.
4. To test your code changes for a task, from the integrated terminal run dotnet test again.

For convenience, a tasks.json configuration file exists for each kata. It allows Visual Studio Code to run the build and test steps from the Command Palette. Press Ctrl + Shift + P (or ⌘ + Shift + P on macOS) to open the Palette and type Run Build Task or Run Test Task and press Enter.

Run katas locally with Docker

You can use the included Dockerfile to create a docker image with all the necessary tools to run the katas from the command line or Jupyter.

1. Install Docker.
2. Build the docker image and tag it katas:

docker build -t katas .

3. Run the image in the container named katas-container with interactive command-line and redirect container port 8888 to local port 8888 (needed to run Jupyter):

docker run -it --name katas-container -p 8888:8888 katas /bin/bash

4. From the same command line that you used to run the container, run the C# version of the BasicGates kata:

cd ~/BasicGates/
dotnet test

5. Start a Jupyter Notebook within the image for the BasicGates kata:

cd ~/BasicGates/ && jupyter notebook --ip=0.0.0.0 --no-browser

6. Once Jupyter has started, use your browser to open the kata in notebook format. You will need a token generated by Jupyter when it started on the previous step:

http://localhost:8888/notebooks/BasicGates.ipynb

To exit a docker container without killing it (daemon mode), press Ctrl+P, Ctrl+Q

To re-enter the existing katas-container (in daemon mode):

docker attach katas-container

Once you're done, remove the katas-container:

docker rm --force katas-container

Contributing

This project welcomes contributions and suggestions. See How Can I Contribute? for details.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.