Project Update
二维热传导的模拟代码工程化
本次更新进一步将代码工程化,通过重构项目目录、统一模块命名、规范包内导入,并使用 SimulationConfig 配置对象集中传递参数,降低了模块间耦合及参数错位风险,提升了代码的可读性、可维护性和可扩展性。
在此过程中,我学到了关于项目不同的代码文件的作用:
| 文件/目录 | 作用 |
|---|---|
| README.md | 项目说明书,记录项目用途、安装方法、运行命令和模型说明。别人拿到项目后应先看它。 |
| pyproject.toml | Python 项目的标准配置文件,声明项目名称、版本、支持的 Python 版本以及 NumPy、Matplotlib 等依赖。 |
| .gitignore | 告诉 Git 哪些生成文件不应纳入版本控制,例如 __pycache__、虚拟环境和测试缓存。 |
| main.py | 根目录兼容入口,使用户可以继续执行 python main.py。它本身不再包含业务逻辑。 |
heat2d/ | 真正存放程序代码的 Python 包。把业务代码集中到包中,可以避免根目录文件杂乱。 |
tests/ | 自动化测试目录,可以放置网格、边界条件和求解器测试。 |
这些文件我暂时并没有完全弄明白是起什么作用的,但我确实认识到他们一定是很重要的()
项目的README.md是我让gpt生成的关于目前项目的详细介绍,为了节约篇幅我单独贴在下一个帖子当中
CODE PROJECT
二维热传导的模拟代码工程化
正在加载 Monaco Editor…