Azure Quantum SDK

Introduction

This repository contains the azure-quantum Python SDK.

Use azure-quantum SDK to submit quantum jobs written in Q#, Qiskit, or Cirq to the Azure Quantum service:

• azure-quantum

Installation and getting started

To install the Azure Quantum package, run:

pip install azure-quantum

If using qiskit, cirq or qsharp, include the optional dependency as part of the install command:

pip install azure-quantum[qiskit]
pip install azure-quantum[cirq]
pip install azure-quantum[qsharp]

To get started, visit the following Quickstart guides:

• Quickstart: Submit a circuit with Qiskit
• Quickstart: Submit a circuit with Cirq
• Quickstart: Submit a circuit with a provider-specific format.

Development

See CONTRIBUTING for instructions on how to build and test.

Contributing

For details on contributing to this repository, see the contributing guide.

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.opensource.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., status check, 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 [email protected] with any additional questions or comments.

Note on Packages

While we encourage contributions in any part of the code, there are some exceptions to take into account.

• The package azure.quantum._client is autogenerated using the Azure Quantum Swagger spec. No manual changes to this code are accepted (because they will be lost next time we regenerate the client).

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.