Skip to main content

Documentation

Python interface for the National Quantum Computing Testbed (NQCT).

The NQCT Python SDK lets researchers and developers work with NQCT programmatically from Python, Jupyter notebooks, scripts, and automated workflows. Use it to discover available quantum computing resources, submit work, monitor jobs, and retrieve results.

The SDK provides programmatic access to the same NQCT environment available through the NQCT Cloud portal (see Developer documentation).

NQCT is an evolving platform. We welcome feedback, bug reports, feature requests, and complaints. See Feedback and support below.


Getting started

The easiest way to get started is through the example Jupyter notebooks in this repository.

They are designed to take you from your first connection to NQCT through progressively more advanced workflows.

New to the SDK? Start here:

  1. Get an NQCT account and API key.
  2. Install the Python SDK.
  3. Open the Getting Started notebook.
  4. Follow the examples and adapt them to your own work.
  5. Explore the other notebooks as you become familiar with the platform.

See Examples and notebooks.


Installation

Install the SDK using Python's package manager:

pip install nqct

Note: The package will be published to PyPI as the project reaches its public release. Until then, see the repository documentation for the current installation method.

You will also need an NQCT API key to access the platform.

API keys are managed through your NQCT account.


Feedback and support

NQCT is an active research and development platform, and user feedback is an important part of its development.

If you encounter a problem, have a feature request, disagree with how something works, or simply have feedback about your experience, please open an issue on GitHub.

GitHub Issues are also the preferred forum for discussion and feedback.

Open an issue or join the discussion.


Related resources

Resource Description
NQCT Cloud NQCT web portal
NQCT Python SDK This repository
NQCT Cloud platform NQCT platform and API
NQCT API documentation API reference

Project status

The NQCT Python SDK is under active development.

Current functionality and interfaces may evolve as the NQCT platform develops. See the CHANGELOG for significant changes between releases.

For the latest information about supported capabilities, see the example notebooks and current technical documentation.

Download files

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

Source Distribution

nqct-0.2.0.tar.gz (289.2 kB view details)

Uploaded Source

Built Distribution

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

nqct-0.2.0-py3-none-any.whl (29.8 kB view details)

Uploaded Python 3

File details

Details for the file nqct-0.2.0.tar.gz.

File metadata

  • Download URL: nqct-0.2.0.tar.gz
  • Upload date:
  • Size: 289.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nqct-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f41d9309c2ba0a2127a3e5adea3290fc477aded990dadb1362ca8040697be6bb
MD5 e2730c644a3141077d8c09874c2fdc77
BLAKE2b-256 e87813453a8016b66102c56678f3e6fc13e11a5f9c98ae0ff72fc521955f0ad2

See more details on using hashes here.

Provenance

The following attestation bundles were made for nqct-0.2.0.tar.gz:

Publisher: release.yaml on NQCT-Australia/nqct-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nqct-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: nqct-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 29.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nqct-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b47e60b9a5672c127277d90327268255e0342ccfb31a5be9ef5f2156a5e365b5
MD5 4d55ca92fdc2a65d5e608bf946de8fc4
BLAKE2b-256 96fd5c1394ae33f304babb2f10a31eb3270f49017349377ef524b234590768d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for nqct-0.2.0-py3-none-any.whl:

Publisher: release.yaml on NQCT-Australia/nqct-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page