Ctrl+K

IQM Client

CI badge Release badge Black badge

IQM Client#

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

Installation#

IQM client is not intended to be used directly by human users. For executing code on an IQM quantum computer, you can use for example the Qiskit on IQM library.

If you want just this library, though, you can install it from the Python Package Index (PyPI):

$ pip install iqm-client

Documentation#

Documentation for the latest version is available online. You can build documentation for any older version locally by cloning the Git repository, checking out the corresponding tag, and running the docs builder. For example, to build the documentation for version 15.4:

$ git clone git@github.com:iqm-finland/iqm-client.git
$ cd iqm-client
$ git checkout 15.4
$ tox run -e docs

tox run -e docs will build the documentation at ./build/sphinx/html. This command requires the tox,, sphinx and sphinx-book-theme Python packages (see the docs optional dependency in pyproject.toml); you can install the necessary packages with pip install -e ".[dev,docs]"

Contents