Metadata-Version: 2.4
Name: uqc-algorithm
Version: 0.1.0
Summary: UQC algorithm package
Author-email: ustcwyx <ustcwyx@gmail.com>
License-Expression: Apache-2.0
Keywords: qiskit,sdk,quantum
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.26
Requires-Dist: qiskit>=2.0.1
Requires-Dist: qiskit-aer>=0.17.0
Requires-Dist: qiskit-experiments>=0.10.0
Provides-Extra: test
Requires-Dist: networkx>=3.0; extra == "test"
Requires-Dist: pytest~=8.3.5; extra == "test"
Requires-Dist: pytest-cov~=6.1.1; extra == "test"
Dynamic: license-file

# uqc_algorithm

`uqc_algorithm` 是一个面向离子阱量子计算场景的算法库，提供以下核心能力：

- **Primitive**：统一采样与期望值估计接口（`UQCSampler` / `UQCEstimator`）。
- **VQE**：任务化的变分求解流程（创建任务、后端连接、预处理、分组、测量）。
- **QAOA**：面向组合优化的建模与优化流程（建模、构建电路、评估、优化与结果汇总）。

## 文档入口

详细文档位于 `docs/docs/`，站点首页源文件为：

- `docs/docs/index.md`

主要文档页面包括：

- `quickstart.md`
- `primitive_module.md`
- `vqe_module.md`
- `qaoa_module.md`
- `troubleshooting.md`
- `faq.md`

## 文档阅读说明

仓库已提供完整站点文档内容，你可以直接从 `docs/site/index.html` 开始阅读。

如果你在代码仓里按文件阅读，建议顺序：

1. `docs/site/quickstart.html`
2. `docs/site/primitive_module.html`
3. `docs/site/vqe_module.html`
4. `docs/site/qaoa_module.html`
5. `docs/site/troubleshooting.html`
6. `docs/site/faq.html`
