23 lines
978 B
Markdown
23 lines
978 B
Markdown
# 工具目录说明
|
||
|
||
文档状态:0.6.3 文档整理稿
|
||
|
||
## 用途
|
||
|
||
`tools` 目录保存 benchmark 编排、测试辅助、检查脚本和开发工具。这里的程序通常服务于示例或验收,不应被误写成主 `femlite` 程序的通用生产入口。
|
||
|
||
## 维护规则
|
||
|
||
- benchmark 编排工具可以链接 `femlite_core`,但不应复制第二套生产算法。
|
||
- 示例 checker 应放在对应 `examples/<case>` 目录,通用测试辅助可放在 `tools/testing`。
|
||
- 生成的 CSV、VTK、restart、临时报告和缓存文件不得提交。
|
||
- 新增工具时必须在相关示例 README 或 `docs/11_benchmark_matrix.md` 中说明用途、运行命令和验收指标。
|
||
|
||
## 常见子目录
|
||
|
||
- `tools/benchmarks`:benchmark 编排程序。
|
||
- `tools/testing`:CTest、示例 smoke 和源码门禁辅助脚本。
|
||
|
||
## 边界
|
||
|
||
工具目录不是公共 API。对外稳定接口以 `docs/05_interface_control_document.md` 和 `include/femlite_c_api.h` 为准。 |