使用指南:arxiv-collector —— 便捷的LaTeX源码上传助手
1. 项目介绍
arxiv-collector 是一个轻量级的Python脚本,由Dougal J Sutherland开发并维护。该工具专为学者及科研人员设计,旨在简化将LaTeX源文件及其依赖项准备并打包上传至arXiv的过程。它自动处理可能令人尴尬的评论条目,默认移除(可通过命令行选项禁用此功能),并且智能地包含如biblatex等系统包以避免上传时的错误。支持Python 3以及旧版的Python 2.7。
2. 快速启动
安装步骤
首先,确保你的环境中已安装Python。然后,通过pip安装arxiv-collector:
pip install arxiv-collector
使用示例
在你的项目主目录下执行以下命令来准备提交到arXiv的文件。如果你只有一个tex
文件或项目结构简单,直接运行:
arxiv-collector
如果有多个tex
文件且需要指定特定文件,可以这样做:
arxiv-collector yourmainfile.tex
想要获取更多参数和配置选项,使用帮助命令:
arxiv-collector --help
3. 应用案例和最佳实践
最佳实践一:自动化编译与上传
对于持续更新的项目,推荐集成到LaTeX编译流程中。例如,使用latexmk
结合arxiv-collector自动收集依赖并生成用于上传的.tar.gz
文件。在项目中创建或修改latexmkrc
文件,加入以下内容:
$dependents_list = 1;
$deps_file = "arxiv_deps";
END {
system("python arxiv_collector.py --latexmk-deps \$deps_file");
}
完成设置后,每次编译后你会得到一个准备好的arxiv.tar.gz
文件,直接上传至arXiv即可。
4. 典型生态项目
虽然该项目本身聚焦于arXiv上传过程中的便捷性,其生态并不直接关联到其他特定的外部项目。然而,在学术出版领域,它可以与LaTeX编辑器如TeXstudio、Overleaf,以及其他自动化构建工具如GitLab CI/CD、GitHub Actions整合,以实现从撰写到提交的一体化工作流。
以上就是关于arxiv-collector的基本介绍、快速启动指南、应用场景及与生态系统的一些建议,希望对您使用这个工具上传LaTeX文档至arXiv有所帮助。