Skip to Content
文档UnitaryLab 模拟器用户手册API 使用总览

API 使用总览

本页是 UnitaryLab 模拟器的 API 入口导航，说明各模块的职责和推荐阅读路径。本页不是完整的 API Reference，函数签名和参数细节请查阅各章节文档。

推荐导入方式

from unitarylab.core import Circuit

Circuit 是所有操作的起点。普通用户只需与 core 层交互；backend、circuit_analysis、drawer 仅在调试或性能调优时才需直接使用。

模块分层

unitarylab/
├── core/               # 用户入口层：Circuit、Register、ClassicalRegister
├── backend/
│   ├── gate/           # 门描述：QuantumGate
│   ├── gatesequence/   # 有序门列表：GateSequence
│   ├── execution/      # 状态向量执行：ExecutionResult
│   ├── configuration/  # 设备与数据类型：DeviceManager、DatetypeManager
│   ├── pygates/        # 底层门核函数（NumPy / PyTorch）
│   └── qasm/           # OpenQASM 3.0 导入导出
├── circuit_analysis/   # 线路静态分析：CircuitInfo
├── drawer/             # 线路绘图：CircuitDrawer
└── library/            # 算法库：QFT、QPE、LCU、HHL 等

核心文档页面

核心线路接口

线路构建的完整参考，包括：

  • 创建 Circuit，使用 Register / ClassicalRegister
  • 单比特门（h、x、rx、rz 等）、双比特门（cx、swap）
  • 受控门、自定义门、线路变换（inverse()、compose()、decompose() 等）
  • measure 操作和经典寄存器

线路执行与工具流程

执行线路及配套工具的综合参考，包括：

  • Circuit.execute() 和 ExecutionResult（state、probabilities、classical_results_map）
  • backend、device、dtype 参数
  • qc.draw() 绘图和 CircuitInfo / qc.analyze() 线路分析
  • OpenQASM 3.0 导出（gate_sequence_to_openqasm3）与导入（openqasm3_to_gate_sequence）

算法与工具库

内置算法模块，包括：

算法导入路径
QFTfrom unitarylab.library._qft import QFT
QPEfrom unitarylab.library._qpe import QPE
LCUfrom unitarylab.library._lcu import LCU
HHLfrom unitarylab.library.linear_solver.hhl import HHL
Trotterfrom unitarylab.library.hamiltonian.method.trotter.algorithm import ...
Pauli 分解from unitarylab.library.pauli_operator.pauli_string_decomposition import pauli_string_decomposition

推荐阅读顺序

  1. 核心线路接口 — 构建线路
  2. 线路执行与工具流程 — 执行、查看结果、分析、绘图、OpenQASM
  3. 算法与工具库 — 算法应用
最后更新于
快速开始核心线路接口