Skip to main content

Python SDK for OQTOPUS Cloud User API

Project description

OQTOPUS logo

OQTOPUS Client

Python client library for the OQTOPUS Cloud User API.

Overview

OQTOPUS Client is a Python SDK for the OQTOPUS Cloud User API.

It is designed for users who want to submit, monitor, and retrieve quantum jobs from Python without handling raw HTTP requests directly. The library provides a synchronous public API for ease of use, while handling network communication asynchronously inside the client.

The SDK covers both low-level API access and higher-level convenience helpers. You can work directly with typed request/response models when you need explicit control, or use helpers such as OqtopusJobSpec, run_*, and typed result wrappers for a more concise workflow.

Features

  • Typed Python access to the OQTOPUS Cloud User API.
  • Job submission helpers for sampling, estimation, multi-manual, and SSE (Server-Side Execution) workflows.
  • Job lifecycle operations such as submit, wait, status, cancel, and delete.
  • Typed result wrappers and generated Pydantic models.
  • Configuration via config files, environment variables, or explicit OqtopusConfig.
  • Built-in retry and backoff controls.

Documentation

Citation

You can use the DOI to cite OQTOPUS in your research.

DOI

Citation information is also available in the CITATION file.

Contact

You can contact us by creating an issue in this repository or by email:

License

OQTOPUS Client is released under the Apache License 2.0.

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

oqtopus_client-1.0.1.tar.gz (54.6 kB view details)

Uploaded Source

Built Distribution

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

oqtopus_client-1.0.1-py3-none-any.whl (101.1 kB view details)

Uploaded Python 3

File details

Details for the file oqtopus_client-1.0.1.tar.gz.

File metadata

  • Download URL: oqtopus_client-1.0.1.tar.gz
  • Upload date:
  • Size: 54.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for oqtopus_client-1.0.1.tar.gz
Algorithm Hash digest
SHA256 618db0ca85f79df355527f115ef020a37bf9f0b0ea03ff5680564ba59c273c4a
MD5 ad173c2193fe4113d5d99945a4057bec
BLAKE2b-256 d459db775cebeda05a8d8ee029b6154ddf711c70dd7f9e23a97ad1e70658104d

See more details on using hashes here.

Provenance

The following attestation bundles were made for oqtopus_client-1.0.1.tar.gz:

Publisher: python-publish.yaml on oqtopus-team/oqtopus-client

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

File details

Details for the file oqtopus_client-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: oqtopus_client-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 101.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for oqtopus_client-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8eddbdcc6cf3d1f2779e10b2a34c1223d5fadaa921c5147a1947e0ee57adc8d8
MD5 5822d70029b4f13b4ee1289725dba6a1
BLAKE2b-256 0515a091cd5593bf68f14ab87ed17b0b235086a461f26387c0a455c0c560f4bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for oqtopus_client-1.0.1-py3-none-any.whl:

Publisher: python-publish.yaml on oqtopus-team/oqtopus-client

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

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