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 public API is primarily synchronous for ease of use, while network communication is handled asynchronously inside the client.
The SDK includes two layers:
- a higher-level SDK surface for common workflows such as sampling, estimation, multi-manual jobs, and SSE jobs
- a generated low-level OpenAPI client for direct access to API models and endpoint bindings
Use this documentation site when you want installation help, end-to-end usage examples, API reference pages, or contributor guidance.
Features¶
- Typed Python access to the OQTOPUS Cloud User API
- Convenience helpers such as
OqtopusJobSpec,run_*, and typed result wrappers - Job lifecycle operations such as submit, wait, status, cancel, and delete
- Parsed device metadata through
OqtopusDevice - Generated OpenAPI models and low-level client bindings under
oqtopus_client.rest - Configuration via config files, environment variables, or explicit
OqtopusConfig - Retry and backoff controls for retryable requests
Usage¶
- Getting Started: installation, configuration, first job submission, and result handling
- Examples: runnable examples and common usage patterns
API Reference¶
- API Reference Overview: entry point for all reference documentation
- SDK Reference: high-level SDK
objects such as
OqtopusClient,OqtopusConfig, job specs, and typed results - Generated OpenAPI Reference: generated API classes, transport helpers, and OpenAPI models
Developer Guidelines¶
Citation¶
You can use the DOI to cite OQTOPUS in your research.
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.