Microsoft Quantum Development Kit: Q# runtime

Welcome to the Microsoft Quantum Development Kit!

This repository contains the runtime components for the Quantum Development Kit. It consists of the libraries and packages needed to create and simulate quantum applications using Q#.

• Azure/: Source for client package to create and manage jobs in Azure Quantum.
• Simulation/: Source for Q# simulation. Includes code generation, full-state and other simulators.
• xUnit/: Source for the xUnit's Q# test-case discoverer.

New to Quantum?

See the introduction to quantum computing provided with the Quantum Development Kit.

Installing the Quantum Development Kit

If you're looking to use Q# to write quantum applications, please see the instructions on how to get started with using the Quantum Development Kit including the Q# compiler, language server, and development environment extensions.

Please see the installation guide for further information on how to get started using the Quantum Development Kit to develop quantum applications. You may also visit our Quantum repository, which offers a wide variety of samples on how to write quantum based programs.

Building from Source

Note that when building from source, this repository is configured so that .NET Core will automatically look at the Quantum Development Kit prerelease feed in addition to any other feeds you may have configured.

Building QIR Runtime isn't enabled by default yet. Please see its readme for details.

Windows

To build on Windows:

1. Install the pre-reqs:
   • Install CMake
   • Install Visual Studio 2019 (version 16.3 or later). Make sure you install the following workloads:
     • Desktop development with C++
     • From the Individual Components tab in VS Installer add Spectre-mitigated libs that match your C++ build tools version
     • .NET Core 3 cross-platform development
2. Run bootstrap.ps1 from PowerShell
   • pre-req (in PowerShell): Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
   • The script might install additional tools (a specific compiler, build tools, etc)
   • Then it builds release flavor of the native (C++) full-state simulator and debug flavor of the Simulation solution.
   • You only need to run it once.
3. Open and build the Simulation.sln solution in Visual Studio.

The Simulation.sln solution does not include the full-state quantum simulator. To change it, you can open the quantum-simulator.sln solution created during bootstrap in the src\Simulation\Native\build. To integrate your changes with the rest of the simulation components, you must manually build it.

macOS/Linux

To build on other platforms:

1. Install the pre-reqs:
   • Install CMake
   • Install .NET Core 3 SDK
   • On WSL/Linux:
     • Install libomp needed for the native (C++) full-state simulator.
     • The build does not accept dotnet-*-5.0 packages, install dotnet-*-3.1 (sudo apt-get install dotnet-sdk-3.1). The possible result can be:

qsharp-runtime$ dpkg -l *dotnet*
Desired=Unknown/Install/Remove/Purge/Hold
| Status=Not/Inst/Conf-files/Unpacked/halF-conf/Half-inst/trig-aWait/Trig-pend
|/ Err?=(none)/Reinst-required (Status,Err: uppercase=bad)
||/ Name                      Version      Architecture Description
+++-=========================-============-============-=================================================================
un  dotnet                    <none>       <none>       (no description available)
ii  dotnet-apphost-pack-3.1   3.1.13-1     amd64        Microsoft.NETCore.App.Host 3.1.13
ii  dotnet-host               5.0.4-1      amd64        Microsoft .NET Host - 5.0.4
ii  dotnet-hostfxr-3.1        3.1.13-1     amd64        Microsoft .NET Core Host FX Resolver - 3.1.13 3.1.13
un  dotnet-nightly            <none>       <none>       (no description available)
ii  dotnet-runtime-3.1        3.1.13-1     amd64        Microsoft .NET Core Runtime - 3.1.13 Microsoft.NETCore.App 3.1.13
ii  dotnet-runtime-deps-3.1   3.1.13-1     amd64        dotnet-runtime-deps-3.1 3.1.13
ii  dotnet-sdk-3.1            3.1.407-1    amd64        Microsoft .NET Core SDK 3.1.407
ii  dotnet-targeting-pack-3.1 3.1.0-1      amd64        Microsoft.NETCore.App.Ref 3.1.0

2. Run bootstrap.ps1
   • The script might install additional tools (a specific compiler, build tools, etc)
   • Then it builds release flavor of the native (C++) full-state simulator and debug flavor of the Simulation solution.
   • You only need to run it once.
3. From the command line, run:
   • dotnet build Simulation.sln

The Simulation.sln solution does not include the full-state simulator. To integrate any changes with the rest of the simulation components, you need to manually build it using make in the src\Simulation\Native\build folder.

Testing

All unit tests are part of the Simulation.sln solution. To run the tests:

• From Visual Studio:
  • Open Test Explorer by choosing Test > Windows > Test Explorer from the top menu bar.
  • Run your unit tests by clicking Run All.
• From the command line, run:
  • dotnet test Simulation.sln

Feedback

If you have feedback about the Q# simulators or any other runtime component, please let us know by filing a new issue! If you have feedback about some other part of the Microsoft Quantum Development Kit, please see the contribution guide for more information.

Reporting Security Issues

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

Legal and Licensing

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

For more details, please see CONTRIBUTING.md, or the contribution guide.