如何用 Git 管理研究代码

用 Git 跟踪科研代码,记录生成论文表格或图表时所用的提交版本。

语言简体中文

先决定哪些文件值得跟踪

Git 会为选中的文件记录一份快照。可以从 README、分析脚本和数据字典开始。这个系列的模拟 CSV 很小,也可以纳入。真实研究里的数据先核对使用和分享权限。对于受限或体积很大的输入,在仓库里记录有权限的同事该怎么获取。

可以把本地环境、可重新生成的结果和临时文件写进 .gitignore。暂存前用 git status 看一眼。忽略规则适用于未跟踪文件,历史提交中已经存在的文件仍然会保留。

.venv/
__pycache__/
results/

保存第一份快照

先下载学习时长示例项目,再在解压后的 study-sessions/ 目录中运行下面的命令。包里已有 README、数据字典、分析脚本和 .gitignore。

git init
git status --short
git add README.md .gitignore data/sessions.csv data/data-dictionary.md analysis/analyze.py
git diff --cached
git commit -m "Add study-session data and mean-duration analysis"

git add 选出要放进快照的内容,git diff --cached 让你检查已暂存的改动,git commit 保存这份快照。首次提交时,Git 可能要求配置姓名和邮箱。执行推送前,提交留在本地。

怎样记录生成论文结果时的 Git 版本

为报告生成表格时,同时记录完整提交 ID 和输入数据的版本。这个 ID 只有在包含你实际运行的改动时才有用。先检查是否还有未提交的修改,再用目标版本重跑一遍。

git status --short
git rev-parse HEAD
git log --oneline -5

git rev-parse HEAD 输出完整的提交 ID。把它放进运行记录或报告附录,以后即使脚本改了,合作者也能找到当时的版本。例如,在报告中把提交 ID 记在安静环境平均 25.0 分钟这条结果旁。以后要查看当时的脚本,把 <commit-id> 换成保存的 ID,再运行:

git show <commit-id>:analysis/analyze.py

练习提交一处小修改

在 README 里补一句,说明为什么示例使用模拟数据。只暂存这个文件,检查差异,再用一句能说明改动的提交信息保存。

查看示例命令
git add README.md
git diff --cached
git commit -m "Explain the origin of the synthetic data"
git log -2 --oneline

参考资源

本文参考并改编自 The Turing Way Community 以 CC BY 4.0 发布的章节。Miss Formula 重新组织了教学顺序,补充了讲解,并编写了贯穿示例和练习。