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.0.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.0-py3-none-any.whl (101.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: oqtopus_client-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 194fb231083ee970f38a48579e573ed8a169a2a05c3f1180467e67c0021fd13e
MD5 2221c0b64f7931b48ce5731c37ad5de2
BLAKE2b-256 113dbe6a30e77b718801beb94ca46f6f2d8db297edbe92f05692f8bd611d2932

See more details on using hashes here.

Provenance

The following attestation bundles were made for oqtopus_client-1.0.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: oqtopus_client-1.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 92b27bf1b6ca720f1cbfbc10d81b2b27516e28cf81e203680353952c8d8cc870
MD5 a5c59408479f81c680769aa3240f83fc
BLAKE2b-256 f72191ab22b50ee91f41362264ae015cce64151e1b4618bcb63260d9b55669bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for oqtopus_client-1.0.0-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