nteract/papermill

Instructions on how to cite papermill in an academic paper.

Open

#881 创建于 2026年5月12日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (5,381 star) (402 fork)batch import
enhancementhelp wanted

描述

Addition to documentation

Instructions on how to cite papermill in an academic paper in either your README.md or documentation.

Motivation

I am writing an academic manuscript on BEAST_pype. I have used papermill extensively within that project and would like to give papermill's the authors full credit.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic knowledge of academic citation conventions
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
Add a section to the README.md or documentation site (papermill.readthedocs.io) explaining how to cite Papermill in academic papers. Look at existing documentation for citation examples from similar projects (e.g., Jupyter, NumPy). The citation should include authors, title, year, version, and DOI. Check if the project has a CITATION.cff file or a Zenodo DOI; if not, suggest creating one. The contribution requires editing Markdown files in the repository, likely in the README or under docs/.