Skip to main content

The SDK in the Tergite software stack for connecting to the Swedish quantum computer

Project description

Tergite

PyPI version license CI PyPI pyversions

The SDK in the Tergite software stack for connecting to the Swedish quantum computer.

It includes:

This project is developed by a core group of collaborators. Chalmers Next Labs AB (CNL) takes on the role of managing and maintaining this project.

Version Control

The tergite stack is developed on a separate version control system and mirrored on Github. If you are reading this on GitHub, then you are looking at a mirror.

Installation

Install using pip

pip install tergite

Dependencies

Provider Setup

  • Ensure you have Python +3.12 installed.

  • Create an account with QAL 9000 if you haven't already. (Or you can have your own tergite Frontend running)

  • With the credentials received from Tergite, create and save a provider account by calling Tergite.use_provider_account(..., save=True).

from tergite import Tergite

provider = Tergite.use_provider_account(
    service_name="MY_SERVICE_NAME",
    url="https://api.qal9000.se",  # or the URL to your own tergite MSS,
    token="MY_API_TOKEN",
    save=True,
)

The code above stores your credentials in a configuration file called tergiterc, located in $HOME/.qiskit folder, $HOME being your home directory.

Once saved, you can retrieve this particular account using the SERVICE_NAME from anywhere in your code. From the provider, you can retrieve any backend you wish by name.

provider = Tergite.get_provider(service_name="MY_SERVICE_NAME")

# display list of backends
print(provider.backends())

# access the 'Loke' backend
backend = provider.get_backend("Loke")

Create a Throw-away Provider Account

  • Alternatively, you can create a provider account that won't be saved. This is useful in things like automated tests. Just call the Tergite.use_provider_account(account) without the save option.
from tergite import Tergite

# the account from before
provider = Tergite.use_provider_account( 
    service_name="MY_SERVICE_NAME",
    url="https://api.qal9000.se",  # or the URL to your own tergite MSS
    token="MY_API_TOKEN",
)

Examples and demos

This project has a long history with contributions of many different partners. All files in the archive folder are scripts from live demonstrations, which show the historical progression of the project. Since research in quantum computing is moving fast, these files are meant to inspire and might not be functional with the source code of this library.

To find out how to use the library, please take a look into the notebooks and scripts inside the examples folder.

ToDo

  • Add docs and doc generation
  • Convert archives into examples, adding proper credits and timestamps

Contribution Guidelines

If you would like to contribute to tergite, please have a look at our contribution guidelines

Authors

This project is a work of many contributors.

Special credit goes to the authors of this project as seen in the CREDITS file.

ChangeLog

To view the changelog for each version, have a look at the CHANGELOG.md file.

License

Apache 2.0 License

Acknowledgements

This project was sponsored by:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tergite-2025.6.0.tar.gz (119.6 kB view details)

Uploaded Source

Built Distribution

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

tergite-2025.6.0-py3-none-any.whl (88.8 kB view details)

Uploaded Python 3

File details

Details for the file tergite-2025.6.0.tar.gz.

File metadata

  • Download URL: tergite-2025.6.0.tar.gz
  • Upload date:
  • Size: 119.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for tergite-2025.6.0.tar.gz
Algorithm Hash digest
SHA256 1ea55012a7797a7ef8d016e4e01045617f1a7e4cc0ea4495a1308b6dad79d70c
MD5 0165b73d4c37072c547379e1b1a5d7b1
BLAKE2b-256 3fa63107d83a6192a78e494f8a36487cbcea06693c12c801b82ed8187c934cfa

See more details on using hashes here.

File details

Details for the file tergite-2025.6.0-py3-none-any.whl.

File metadata

  • Download URL: tergite-2025.6.0-py3-none-any.whl
  • Upload date:
  • Size: 88.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for tergite-2025.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fa077ee70386bf19344a0cf3bd4f2456d89d65dc4455fd8df6498d393341030a
MD5 9f49acccfeda20526c0dc3aacd394636
BLAKE2b-256 acad8f1bb9e171e934129f298627974739e4b4eef59514fd8b2f1bcdbde9cdfd

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