Metadata-Version: 2.5
Name: qdash-sdk
Version: 1.10.5b1295
Summary: Python SDK for defining and running QDash calibrations
Author-email: OQTOPUS Team <oqtopus-team@googlegroups.com>
Requires-Python: <3.13,>=3.11
Requires-Dist: qdash-client==1.10.5b1295
Description-Content-Type: text/markdown

# qdash-sdk

`qdash-sdk` provides `qdash.sdk`: the `QDash` session, which validates and starts calibrations
on a chip and lists and runs the workflows registered in a project, and the calibration
definitions, built on
[`qdash-client`](../../clients/python/README.md). Installing it installs the matching
`qdash-client` release:

```bash
pip install qdash-sdk
```

```python
from qdash.sdk import QDash

with QDash.from_env() as qdash:
    # A registered workflow runs code saved in QDash on the chip it was saved for.
    for summary in qdash.workflows.list():
        print(summary.name, summary.chip_id)
    workflow = qdash.workflows.get("coherence_check")
    result = workflow.run(parameters={"qids": ["0", "1"]}).wait()
    print(result.status)
```

The [Python client guide](../../docs/reference/clients/python.md) covers configuration,
`chip.calibrate(targets, steps)`, which runs steps defined in Python on the chip you name,
registered workflows and the pipeline API.

## Develop the Package

Install the workspace and run the SDK checks from the repository root:

```bash
uv sync --all-groups --all-packages
task test-sdk
```

`src/qdash/sdk/` holds the SDK sources; API requests, models, configuration, and errors stay in
`qdash-client`. `tests/test_sdk_distributions.py` builds both wheels and checks that each one
installs only its own namespace.

## Version and Publication

`qdash-sdk` has no version of its own. hatch-vcs derives it the same way as `qdash-client`,
and `hatch_build.py` pins the dependency to that version: a build of `X.Y.Z` or `X.Y.ZbN`
requires `qdash-client==X.Y.Z` or `qdash-client==X.Y.ZbN`. Development builds require any
`qdash-client`.

`.github/workflows/publish-qdash-client.yml` publishes both packages from one release record:
`qdash-client` first, then `qdash-sdk`. See
[Python SDK architecture](../../docs/developer-guide/architecture/python-sdk.md#packaging-and-release).
