Python client for Azure Quantum
Project description
Azure Quantum
Azure Quantum is Microsoft's cloud service for running Quantum Computing programs and circuits with our quantum partners and technologies. The azure-quantum package for Python provides functionality for interacting with Azure Quantum workspaces, including creating jobs, listing jobs, and retrieving job results. For more information, view the Azure Quantum Documentation.
This package supports submitting quantum programs or circuits written with Python. To submit quantum programs written with Q#, Microsoft's Domain-specific language for Quantum Programming, view Submit Q# Jobs to Azure Quantum.
Installation
The package is released on PyPI and can be installed via pip:
pip install azure-quantum
To use azure-quantum for submitting quantum circuits expressed with Qiskit, install with optional dependencies:
pip install azure-quantum[qiskit]
To use azure-quantum for submitting quantum circuits expressed with Cirq, install with optional dependencies:
pip install azure-quantum[cirq]
Getting started and Quickstart guides
To work in Azure Quantum, you need an Azure subscription. If you don't have an Azure subscription, create a free account. Follow the Create an Azure Quantum workspace how-to guide to set up your Workspace and enable your preferred providers.
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.
General usage
To connect to your Azure Quantum Workspace, go to the Azure Portal, navigate to your Workspace and copy-paste the resource ID and location into the code snippet below.
from azure.quantum import Workspace
# Enter your Workspace details (resource ID and location) below
workspace = Workspace(
resource_id="",
location=""
)
List all targets
To list all targets that are available to your workspace, run
workspace.get_targets()
Submit a quantum program or circuit
First, define a quantum program or circuit, and create a job by submitting it to one of the available targets:
# Enter target name below
target = workspace.get_targets("mytarget")
# Submit quantum program or circuit
job = target.submit(my_quantum_program)
# Wait for job to complete and fetch results
result = job.get_results()
Examples
You can find example Python scripts that use the Azure Quantum Python API in the examples directory.
Contributing
For details on contributing to this package, 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.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 repositories 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.
Support
If you run into any problems or bugs using this package, please head over to the issues page and open a new issue, if it does not already exist.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file azure-quantum-1.2.1.tar.gz.
File metadata
- Download URL: azure-quantum-1.2.1.tar.gz
- Upload date:
- Size: 108.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: RestSharp/106.13.0.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7a5e283c5e3721ead33b6a6955cdcd8b778905f5c0e7336ee18748ec49618b08 |
|
| MD5 | e6d28f9f03b436af19bfb9405db2150e |
|
| BLAKE2b-256 | fdce03264021c145ce5ceb2e81e50bb6b488d3ff0fe1b2de18c25b9fc9b4a9d6 |
File details
Details for the file azure_quantum-1.2.1-py3-none-any.whl.
File metadata
- Download URL: azure_quantum-1.2.1-py3-none-any.whl
- Upload date:
- Size: 141.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: RestSharp/106.13.0.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c74457543459aff5f999f84eaa3f6b1952d08f57a8b137a6b451f9305ea52f23 |
|
| MD5 | 88544823fea1138983ce71f3fa52bdbc |
|
| BLAKE2b-256 | 74fb53ef26e6bac09fee8f81332e36bc88ac0ea0b0e01b43f7236a91978b1d42 |
