Metadata-Version: 2.4
Name: jiuzhang-sdk
Version: 0.1.0a14
Summary: 九章光量子真机云接入软件包（jiuzhang SDK）
Author: 九章量子 SDK 团队
License: Proprietary
Keywords: gbs,jiuzhang,photonic,quantum,sdk
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.12
Requires-Dist: httpx<0.29,>=0.27
Requires-Dist: numpy>=1.26
Provides-Extra: dev
Requires-Dist: mypy>=1.11; extra == 'dev'
Requires-Dist: pre-commit>=3.8; extra == 'dev'
Requires-Dist: pytest-cov>=5; extra == 'dev'
Requires-Dist: pytest-mock>=3; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Provides-Extra: jupyter
Requires-Dist: ipython>=8; extra == 'jupyter'
Description-Content-Type: text/markdown

# jiuzhang SDK · 九章光量子云平台 Python SDK

This `code/` directory contains the Python package source for `jiuzhang-sdk`.
The SDK talks to the JiuZhang cloud API only; Tianyan is reached by the cloud
platform backend.

本 `code/` 目录是 `jiuzhang-sdk` 的 Python 源码工程。SDK 只调用九章云平台 API；
天衍平台由云平台后台转发。

## Install / 安装

```powershell
pip install --pre jiuzhang-sdk
pip install jiuzhang-sdk==0.1.0a14
pip install -e ".[dev,jupyter]"
```

## Required Task Fields / 必填任务字段

GBS submissions require `project_id` and `device_id`.

GBS 任务提交必须带 `project_id` 与 `device_id`。

```python
from jiuzhang import CloudClient, GBSParams

client = CloudClient(
    base_url="http://127.0.0.1:18081/api/v1",
    api_key="PQ-3f2c2a3b0f7a4a2ab1cdb0b7d2f1a9c4",
)

params = GBSParams(
    project_id="EXP-local-demo",
    device_id="PH_QC_04",
    mt=64,
    pump_energy_nj=2.0,
    squeezing_param=0.35,
)

result = client.run_gbs(params)
```

## API Paths / API 路径

`base_url` may include `/api/v1`.

`base_url` 可以包含 `/api/v1`。

```text
POST /estimate
POST /tasks/submit
GET  /tasks/{task_id}
```

## Environment / 环境变量

```powershell
$env:JIUZHANG_API_KEY="your_api_key"
$env:JIUZHANG_BASE_URL="http://127.0.0.1:18081/api/v1"
$env:JIUZHANG_PROJECT_ID="EXP-local-demo"
$env:JIUZHANG_DEVICE_ID="PH_QC_04"
```

## Local Mock / 本地 Mock

```powershell
python ..\local_test\mock_cloud_platform\mock_cloud_platform.py --port 18081 --mode standalone
```

## Test / 测试

```powershell
ruff format src tests
ruff check src tests
mypy src
pytest
```

## License / 授权

Proprietary. Copyright © 2026 JiuZhang Quantum.
