Skip to main content

Python client for Azure Quantum

Project description

Python SDK for Azure Quantum

The azure-quantum package for Python provides functionality for interacting with Azure Quantum workspaces, including creating jobs, listing jobs, and retrieving job results.

For details on how to get started with Azure Quantum, please visit https://azure.com/quantum.

You can also try our Quantum Computing Fundamentals learning path to get familiar with the basic concepts of quantum computing, build quantum programs, and identify the kind of problems that can be solved.

Installing with pip

pip install azure-quantum

Development

The best way to install all the Python pre-reqs packages is to create a new Conda environment. Run at the root of the azure-quantum directory:

conda env create -f environment.yml -n azure-quantum

Then to activate the environment:

conda activate azure-quantum

Install the local development package

To install the package in development mode, run:

pip install -e .

Unit tests

To run the unit tests, simply run pytest from the root of the azure-quantum directory:

pytest

To run the a specific unit test class, run:

pytest ./tests/unit/test_job.py

To run the a specific unit test case, run:

pytest -k test_job_refresh

Building the azure-quantum Package

The Azure Quantum Python SDK uses a standard setuptools-based packaging strategy. To build a platform-independent wheel, run the setup script with bdist_wheel instead:

cd src/Python/
python setup.py bdist_wheel

By default, this will create a azure-quantum wheel in dist/ with the version number set to 0.0.0.1. To provide a more useful version number, set the PYTHON_VERSION environment variable before running setup.py.

Support and Q&A

If you have questions about the Quantum Development Kit and the Q# language, or if you encounter issues while using any of the components of the kit, you can reach out to the quantum team and the community of users in Stack Overflow and in Quantum Computing Stack Exchange tagging your questions with q#.

Project details


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

azure-quantum-0.17.2105.143879.tar.gz (37.9 kB view details)

Uploaded Source

Built Distribution

azure_quantum-0.17.2105.143879-py3-none-any.whl (64.9 kB view details)

Uploaded Python 3

File details

Details for the file azure-quantum-0.17.2105.143879.tar.gz.

File metadata

  • Download URL: azure-quantum-0.17.2105.143879.tar.gz
  • Upload date:
  • Size: 37.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.9

File hashes

Hashes for azure-quantum-0.17.2105.143879.tar.gz
Algorithm Hash digest
SHA256 6e79d43f0a0c5b0c2dacd1949686ff0cbee338458ddef906618cf2a7940bc6c5
MD5 4ce217bff2cd69ae75e1d927cc977582
BLAKE2b-256 b792b190ea850f6aa112201488a64e1808b81af71808bccde31e78611a24f6d0

See more details on using hashes here.

File details

Details for the file azure_quantum-0.17.2105.143879-py3-none-any.whl.

File metadata

  • Download URL: azure_quantum-0.17.2105.143879-py3-none-any.whl
  • Upload date:
  • Size: 64.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.9

File hashes

Hashes for azure_quantum-0.17.2105.143879-py3-none-any.whl
Algorithm Hash digest
SHA256 6a71b649b983349026a447227eba48667b0379cb7d7d9c1cf39e29633be224d6
MD5 af6853509dd24be50a680f70dba05d17
BLAKE2b-256 5ae195431eac2d6fa07d3ec9b1b3be89efbf48714ceb37dc8b678e0325f076c6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page