为什么需要上传代码
在计算科学、数据科学、工程仿真、计量经济等领域,代码通常是复现实验结果的核心工具,上传代码不仅能提升论文的透明度和可信度,也有助于审稿人核查关键结论,减少“结果无法复现”的争议,越来越多的期刊要求或鼓励作者在投稿时提供源代码、数据处理脚本和运行说明。
但需要注意:并非所有期刊都强制要求上传代码,具体要求应以目标期刊的作者须知、投稿系统说明以及所在机构、主管部门的公开规定为准。
适用条件
以下情况通常适合在投稿时准备并上传代码:
- 论文包含数值实验、仿真模拟、统计分析、机器学习模型训练或算法实现;
- 结果依赖特定参数设置、随机种子、数据预处理流程或环境配置;
- 期刊明确提供“补充材料”“代码仓库”“复现包”等提交入口;
- 研究团队希望公开方法细节,便于后续研究复用。
如果代码涉及未公开的涉密数据、第三方商业许可限制、患者隐私或其他合规问题,应先进行脱敏、授权确认或法律审查,而不是直接上传,无法确认是否允许公开时,应联系期刊编辑部或所在单位科研管理部门核实。
具体步骤
先确认期刊要求
投稿前应阅读期刊官网的作者指南,重点查看:
- 是否要求代码随初稿提交,还是在修改阶段提交;
- 代码应作为补充材料上传,还是提交到外部代码仓库并在论文中给出链接;
- 是否允许只上传核心实验代码,而非全部工程代码;
- 文件格式、大小、命名方式和匿名化要求。
整理可复现的代码包
建议将代码整理为结构清晰的文件夹,
src/:核心算法或模型实现;scripts/:运行实验、生成图表的脚本;data/:示例数据或数据获取说明;requirements.txt或environment.yml:依赖环境;README.md:运行步骤、参数说明和输出说明。
README 文件尤其重要,它应说明:需要哪些软件版本、如何安装依赖、运行哪个脚本、预期生成哪些结果,以及论文中的图表或表格对应哪个脚本。
处理匿名化与版权问题
如果期刊采用双盲审稿,投稿版本中不应包含作者姓名、单位、邮箱、个人主页或可识别的代码仓库链接,可以先使用匿名版本提交,录用后再补充正式仓库地址。
若代码基于第三方开源项目,应保留原许可证声明;若使用商业软件,应说明授权方式,涉及真实数据时,还需确认数据使用是否获得伦理批准或授权。
按投稿系统要求提交
常见方式包括:
- 直接上传压缩包作为补充材料;
- 在论文中附上代码仓库链接,并确保链接在审稿阶段可访问或可按编辑部要求开放;
- 提交“复现包”,包含代码、示例数据和运行说明。
提交后应记录文件名、版本号和提交时间,以便后续修改时对应。
常见误区
- 只上传代码,不写说明:没有 README、依赖清单和运行步骤,审稿人难以判断代码是否可用。
- 把全部工程文件都塞进去:过大的日志文件、缓存文件、编译产物可能增加提交负担,应只保留与论文结果直接相关的部分。
- 默认公开真实数据:若数据受隐私或保密限制,应使用示例数据或说明获取方式,而不是直接上传原始数据。
- 忽视匿名审稿要求:在代码注释、提交记录或文件路径中暴露作者身份,可能影响双盲评审。
- 认为上传代码就一定能提高录用率:代码透明是学术规范的一部分,但不能替代研究问题、方法创新和实验质量。
可核验事项
投稿前建议逐项检查:
- 代码包是否能在干净环境中按 README 运行;
- 是否明确标注软件版本、依赖库版本和操作系统要求;
- 论文中的关键图表、表格或实验结果是否能由代码复现;
- 是否删除了不必要的临时文件、密钥、密码和隐私信息;
- 是否保留了第三方代码的许可证和引用说明;
- 若期刊要求匿名,代码和补充材料中是否去除了作者身份信息;
- 若使用外部仓库,链接是否有效,权限是否符合审稿阶段要求。
上传代码的核心目的不是增加投稿负担,而是让研究过程更可检验、可复用,作者应根据期刊要求、数据合规和研究实际情况决定提交范围,任何关于是否强制公开、是否需要伦理审查、是否允许使用外部仓库的具体问题,都应以期刊官网、投稿系统和所在机构公开规定为准,规范地准备代码包,既能体现学术严谨性,也能为后续复现和交流打下基础。
标签: #期刊论文上传代码