QuEST

<!-- 本 README 避免使用相对路径，因为它也被用作 Doxygen 的主页 --> <!-- 横幅 -->

<img src="https://yellow-cdn.veclightyear.com/835a84d5/578b5d83-5e6d-4e00-8260-fd871c28fba6.png?raw=true" alt="QuEST 标志" width=500>

量子精确模拟工具包（QuEST）是一个高性能的量子电路、态向量和密度矩阵模拟器。QuEST 利用多线程、GPU 加速和分布式计算技术，可在笔记本电脑、台式机和联网超级计算机上快速运行。 QuEST 简单易用；它是独立的，无需安装，编译和运行极为简单。 QuEST 混合了具有广泛编译器支持的 OpenMP 和 MPI，可在各种多核、多 CPU 和分布式硬件上运行，使用 HIP 在 AMD GPU 上运行，集成了 cuQuantum 和 Thrust 以在现代 NVIDIA GPU 上获得尖端性能，并具有自定义内核后端，可在较旧的兼容 CUDA 的 GPU 上运行。 而且它在单一、无缝的接口后隐藏了这些部署模式。

QuEST 由牛津大学 QTechTheory 小组和这些作者开发。要了解更多信息：

• 查看教程
• 浏览文档
• 访问网站
• 查看一些示例
• 阅读白皮书，该白皮书在《科学报告》的物理学 Top 100中榜上有名 :trophy:

---

:tada:  简介

QuEST 拥有简单的接口，可在 CPU、GPU 和网络环境中无缝运行。

hadamard(qubits, 0);

controlledRotateX(qubits, 0, 1, angle);

double prob = calcProbOfOutcome(qubits, 0, outcome);

同时，它也很灵活

Vector v;
v.x = 1; v.y = .5; v.z = 0;
rotateAroundAxis(qubits, 0, angle, v);

ComplexMatrix2 u = {
    .real = {{.5, .5}, { .5,.5}},
    .imag = {{.5,-.5}, {-.5,.5}}};
unitary(qubits, 0, u);

mixDepolarising(qubits, 0, prob);

而且功能非常强大

ComplexMatrixN u = createComplexMatrixN(5);
int ctrls[] = {0, 1, 2};
int targs[] = {5, 20, 15, 10, 25};
multiControlledMultiQubitUnitary(qubits, ctrls, 3, targs, 5, u);

ComplexMatrixN k1, k2, k3 = ...
mixMultiQubitKrausMap(qubits, targs, 5, {k1, k2, k3}, 3);

double val = calcExpecPauliHamil(qubits, hamiltonian, workspace);

applyTrotterCircuit(qubits, hamiltonian, time, order, repetitions);

---

:white_check_mark:  特性

QuEST 支持：

• :ballot_box_with_check:   密度矩阵，用于精确模拟噪声量子计算机
• :ballot_box_with_check:   具有任意数量控制和目标量子比特的通用幺正变换
• :ballot_box_with_check:   任意维度的通用退相干信道
• :ballot_box_with_check:   以泡利基表示的通用厄米算符
• :ballot_box_with_check:   众多算符，包括泡利小工具、解析相位函数和特罗特电路
• :ballot_box_with_check:   多种分析量子态的工具，如概率、保真度和期望值的计算
• :ballot_box_with_check:   通过qreal数值类型实现的可变精度，可使用单精度、双精度或四精度
• :ballot_box_with_check:   QASM输出，用于验证模拟电路
• :ballot_box_with_check:   直接访问振幅，以快速自定义修改量子态
• :ballot_box_with_check:   在MacOS、Linux和Windows上通过Clang、GNU、Intel和MSVC编译器进行本地编译

---

:book:  文档

• 教程包括以下说明：
  • 编译 QuEST
  • 在本地和超级计算机上运行 QuEST
  • 使用综合单元测试测试 QuEST <br><br>
• 文档分为以下模块（汇总在此处）
  • 数据结构
  • 初始化
  • 幺正变换
  • 门
  • 退相干
  • 算符
  • 计算
  • QASM <br><br>
• 用于调试和测试的其他实用工具记录如下
  • 调试
  • 单元测试
  • 测试实用工具

对于开发者：当master分支更新时，QuEST的文档会通过Github Actions自动重新生成。要在本地重新生成文档，请在根目录运行doxygen doxyconfig/config，这将在Doxygen_doc/html中生成html文档。

---

:rocket:  快速入门

要快速开始，请使用git在终端下载QuEST

git clone https://github.com/quest-kit/QuEST.git
cd QuEST

使用cmake和make编译教程示例（源代码）

mkdir build
cd build
cmake ..
make

然后运行

./demo

<br>

Windows用户应安装Visual Studio的Build Tools和CMake，并在Developer Command Prompt for VS中运行上述命令，但使用以下构建命令

cmake .. -G "NMake Makefiles"
nmake

如果以这种方式使用MSVC和NMake失败，用户可以放弃GPU加速，下载 MinGW-w64，并通过以下方式编译

cmake .. -G "MinGW Makefiles"
make

---

:heart:  致谢

我们衷心感谢以下QuEST的外部贡献者。

• Jakub Adamski优化了最大大小消息的分布式通信。
• AMD的Bruno Villasenor Alvarez将GPU后端移植到HIP，以兼容AMD GPU。
• HQS Quantum simulations贡献了CPU上的mixDamping。
• Kshitij Chhabra修复了一些验证错误。
• Drew Silcock修复了MacOS上的多线程构建。
• Zach van Rijn修补了多线程代码，以兼容GCC-9 OpenMP-5。
• SchineCompton修复了GPU CMake发布构建。
• Christopher J. Anders修复了多线程（默认关闭时）和GPU构建（修订最低cmake版本）。
• Gleb Struchalin修复了cmake独立构建。
• Milos Prokop对initDiagonalOpFromPauliHamil进行了串行原型设计。

QuEST使用BSD许可下的mt19937ar梅森旋转算法进行随机数生成。QuEST可选择（通过额外导入QuEST_complex.h）集成Randy Meyers和Dr. Thomas Plum的语言无关复数类型。

---

:newspaper:  相关项目

• QuESTlink <br> 一个Mathematica包，支持符号电路操作、解析模拟、可视化和使用远程加速硬件进行高性能模拟。

• pyQuEST <br> 一个基于Cython的QuEST Python接口，由QTechTheory小组开发。请注意，pyQuEST目前处于alpha阶段。

• PyQuEST-cffi <br> 由HQS Quantum Simulations开发的基于cffi的QuEST Python接口。请注意，PyQuEST-cffi目前处于alpha阶段，不是官方QuEST项目。