NuFHE 项目教程

1. 项目的目录结构及介绍

nufhe/
├── docs/
│   ├── conf.py
│   ├── index.rst
│   └── ...
├── nufhe/
│   ├── __init__.py
│   ├── api.py
│   ├── cuda/
│   │   ├── __init__.py
│   │   ├── kernel.cu
│   │   └── ...
│   ├── opencl/
│   │   ├── __init__.py
│   │   ├── kernel.cl
│   │   └── ...
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_api.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

• docs/: 包含项目的文档文件，使用 Sphinx 生成。
  • conf.py: Sphinx 配置文件。
  • index.rst: 文档主页。
• nufhe/: 项目的主要代码目录。
  • init.py: 初始化文件。
  • api.py: API 接口文件。
  • cuda/: CUDA 相关代码。
  • opencl/: OpenCL 相关代码。
• tests/: 包含项目的测试文件。
  • init.py: 初始化文件。
  • test_api.py: API 测试文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装文件。

2. 项目的启动文件介绍

项目的启动文件主要是 setup.py，它负责项目的安装和打包。通过运行以下命令可以安装项目：

pip install .

3. 项目的配置文件介绍

• docs/conf.py: Sphinx 文档生成配置文件，包含文档的标题、作者、版本等信息。
• requirements.txt: 项目依赖文件，列出了项目运行所需的 Python 包。
• setup.py: 项目安装文件，包含项目的元数据和安装脚本。

通过以上配置文件，可以确保项目在不同环境中的一致性和可复现性。