nteract/papermill

Instructions on how to cite papermill in an academic paper.

Open

#881 opened on 2026年5月12日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (5,381 stars) (402 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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/.