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.9 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(account, save=True).

from tergite.qiskit.providers import Tergite
from tergite.qiskit.providers.provider_account import ProviderAccount

TERGITE_API_URL="https://api.qal9000.se"  # or the URL to your own tergite MSS

account = ProviderAccount(
      service_name="MY_SERVICE_NAME", url="TERGITE_API_URL", token="MY_API_TOKEN"
)
provider = Tergite.use_provider_account(account, 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.
# the account from before
provider = Tergite.use_provider_account(account)

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

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.3.0.tar.gz (58.8 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.3.0-py3-none-any.whl (82.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tergite-2025.3.0.tar.gz
  • Upload date:
  • Size: 58.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.9.21 Linux/6.8.0-1021-azure

File hashes

Hashes for tergite-2025.3.0.tar.gz
Algorithm Hash digest
SHA256 8ccb974d8e08decc178cc54972f5bc968a9921a66d23dece719ff622548a0bbb
MD5 a845e5e217430156753cf1263a669dcb
BLAKE2b-256 5b4fc9a932a44f90ab3c1ca39240db66d3d1c245b4afea2c93c3dabfefbfde14

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tergite-2025.3.0-py3-none-any.whl
  • Upload date:
  • Size: 82.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.9.21 Linux/6.8.0-1021-azure

File hashes

Hashes for tergite-2025.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d2c68bd71baf39f68de9247f4361898352960d3e25bca1ce01d970c87360572
MD5 fe34f472daaa8da6ea61b45cdd3e8a57
BLAKE2b-256 9975905c128d87d5864e42553cfba03d439b1ce3ed819369ecad38fab46d43d6

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