开发工作流

环境准备

CPU 构建

cd QRAM-Simulator
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc)

GPU 构建

CUDA/GPU 后端默认关闭;开启需本机 CUDA 工具链(CUDA 13 / CCCL 3 与 A800 级 GPU 上的 CUDA 12.8 / sm_80 均实测通过,验证记录见仓库内 docs/verification/v1c-gpu-cuda-a800.md)。GPU 代码布局见 CUDA 后端参考。大规模稀疏态运行可加 -DCMAKE_CUDA_FLAGS="-DCACHED_REGISTER_SIZE=<n>"``(``CMAKE_CXX_FLAGS 同步)以压缩每振幅负载——约束与实测效果见 CUDA 后端参考(docs/verification/v1d-qda-linsolver-a800.md)。

cmake .. -DCMAKE_BUILD_TYPE=Release -DSPARQ_ENABLE_CUDA=ON
make -j$(nproc)

Python 绑定

pip install .

核心代码结构

下述头文件的渲染参考:核心组件、寄存器/系统操作、 量子算术、QRAM 与 算法库。

添加新实验

  1. 创建实验目录结构:

    Experiments/
    └── MyAlgorithm/
        ├── MyAlgorithmTest.cpp
        └── CMakeLists.txt
    
  2. 编写 CMakeLists.txt:

    add_executable(MyAlgorithmTest MyAlgorithmTest.cpp)
    target_link_libraries(MyAlgorithmTest PRIVATE SparQ SparQ_Algorithm Common)
    
  3. 在 Experiments/CMakeLists.txt 中注册:

    add_subdirectory(MyAlgorithm)
    

Git 工作流

创建分支并开发:

# 创建功能分支
git checkout -b feat/my-algorithm origin/main

# 开发、测试...

# 推送到 fork
git push origin feat/my-algorithm

CI 验证后提交 PR 到 upstream。

运行测试

# 运行所有测试
cd build && ctest --output-on-failure

# 运行特定测试
./build/bin/MyAlgorithmTest