Files
FemLite/tools/README.md
T
shenw 0440ed5a64
FemLite CI / build-test (push) Has been cancelled
Release FemLite 0.6.4
2026-07-05 17:23:34 +08:00

47 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 工具目录说明
文档状态:0.6.3 文档整理稿
## 用途
`tools` 目录保存 benchmark 编排、测试辅助、检查脚本和开发工具。这里的程序通常服务于示例或验收,不应被误写成主 `femlite` 程序的通用生产入口。
## 维护规则
- benchmark 编排工具可以链接 `femlite_core`,但不应复制第二套生产算法。
- 示例 checker 应放在对应 `examples/<case>` 目录,通用测试辅助可放在 `tools/testing`。
- 生成的 CSV、VTU/PVD、restart、临时报告和缓存文件不得提交。
- 新增工具时必须在相关示例 README 或 `docs/11_benchmark_matrix.md` 中说明用途、运行命令和验收指标。
## 常见子目录
- `tools/benchmarks`:benchmark 编排程序。
- `tools/testing`:CTest、示例 smoke 和源码门禁辅助脚本。
- `tools/release_to_cclite.ps1`:将当前 FemLite 自动构建并发布到 `..\CCLite\FEMLite`,填充 `cpu_release`、`cpu_debug`、`docs` 和 `examples`,并重写目标 examples 的运行脚本路径。
## 发布到 CCLite
默认用法:
```bat
tools\release_to_cclite.bat
```
也可以直接运行 PowerShell 脚本:
```powershell
.\tools\release_to_cclite.ps1
```
脚本默认使用 `C:\gcc-16.1.0-64`,构建 `build-cclite-release` 和 `build-cclite-debug`,然后同步到 `..\CCLite\FEMLite`。若只想复用已有构建并重新拷贝,可使用:
```powershell
.\tools\release_to_cclite.ps1 -SkipBuild
```
若当前系统禁止直接运行 `.ps1`,使用 `tools\release_to_cclite.bat -SkipBuild` 即可。
## 边界
工具目录不是公共 API。对外稳定接口以 `docs/05_interface_control_document.md` 和 `include/femlite_c_api.h` 为准。