Runtime components for Q#
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#.
See the introduction to quantum computing provided with 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.
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.
To build on Windows:
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Simulation.slnsolution in Visual Studio.
Simulation.slnsolution does not include the full-state quantum simulator. To change it, you can open the
quantum-simulator.slnsolution 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.
To build on other platforms:
dotnet build Simulation.sln
Simulation.slnsolution 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
All unit tests are part of the
Simulation.slnsolution. To run the tests:
dotnet test Simulation.sln
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.
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) at [email protected]. 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.
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.