Skip to main content

Client library for accessing an IQM quantum computer

Project description

Client-side Python library for connecting to an IQM quantum computer.

Includes as an optional feature Qiskit and Cirq adapters for IQM’s quantum computers, which allow you to:

  • Transpile arbitrary quantum circuits for IQM quantum architectures

  • Simulate execution on IQM quantum architectures with IQM-specific noise models (currently only the Qiskit adapter contains IQM noise models)

  • Run quantum circuits on an IQM quantum computer

Also includes a CLI utility for managing user authentication when using IQM quantum computers.

Installation

For executing code on an IQM quantum computer, you can use for example the Qiskit on IQM or Cirq on IQM user guides found in the documentation. Qiskit on IQM and Cirq on IQM are optional features that can be installed alongside the base IQM Client library. An example showing how to install from the public Python Package Index (PyPI):

$ uv pip install iqm-client[qiskit,cirq]

The CLI utility for managing user authentication can also be installed as an optional feature:

$ uv pip install iqm-client[cli]

IQM Client by itself is not intended to be used directly by human users. If you want just the base IQM Client library, though, you can install it with

$ uv pip install iqm-client

Documentation

Documentation for the latest version is available online. You can build documentation for any older version locally by downloading the corresponding package from PyPI, and running the docs builder. For versions greater than equal to 20.12 but less than 33.0.0 this is done by running ./docbuild in the iqm-client root directory, and for earlier versions by running tox run -e docs.

./docbuild or tox run -e docs will build the documentation at ./build/sphinx/html.

Versions greater than or equal to 33.0.0 use the command: sphinx-build -q -d build/.doctrees/iqm-client iqm-client/docs build/docs/iqm-client (build/docs/ directory has to be created first).

These commands require installing the sphinx and sphinx-book-theme Python packages and graphviz.

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

iqm_client-33.0.4.tar.gz (316.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iqm_client-33.0.4-py3-none-any.whl (148.2 kB view details)

Uploaded Python 3

File details

Details for the file iqm_client-33.0.4.tar.gz.

File metadata

  • Download URL: iqm_client-33.0.4.tar.gz
  • Upload date:
  • Size: 316.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for iqm_client-33.0.4.tar.gz
Algorithm Hash digest
SHA256 fd735ed7848d4c813700b8400316b54644dd2f40f55e746c21df32fbb88ce40d
MD5 52ec26ee53af38811af9b22da617dc25
BLAKE2b-256 745ede724d55387aabe11a986617fc38d7037566d26b90e9df7eb99fe0151964

See more details on using hashes here.

File details

Details for the file iqm_client-33.0.4-py3-none-any.whl.

File metadata

  • Download URL: iqm_client-33.0.4-py3-none-any.whl
  • Upload date:
  • Size: 148.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for iqm_client-33.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9d3c7dcef52d503236354dac1c0b4e572e9fb89d62232d7dc4ba19d6063052fa
MD5 0397e80764d7fbc889b66d2a45f792ba
BLAKE2b-256 155911be66e71a0c48b9a768d1acb617547186771b2d6ed294054bca631ab71c

See more details on using hashes here.

Supported by

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