microsoft/qdk

Welcome to the Microsoft Quantum Development Kit!

This repository contains tooling for the Q# language, specifically:

There are also the tutorials and samples in the ./katas and ./samples directories, respectively.

Code from this repository powers the Q# development experience on https://quantum.microsoft.com.

To build this repository there are dependencies that need to be installed. These are:

The last two can be installed into your HOME directory by running python ./prereqs.py --install

The build script will check these dependencies and their versions and fail if not met. (Or run python ./prereqs.py directly to check if the minimum required versions are installed).

To build, in the root directory run python ./build.py. By default this will run a release build of each project, including running tests and checks such as linting. Run with the --help option for detailed usage.

The playground is a small website that loads the Q# editor, compiler, samples, katas, and documentation for the standard library. It's a way to manually validate any changes you make to these components.

To see instructions for building the playground, refer to Building the Playground Locally.