repository checklist

• Notebook file in any of the following formats:
  • .qmd (jupyter kernel or knitr engine)
  • .ipynb (jupyter kernel)
  • .Rmd (jupyter kernel or knitr engine)
• README.md which should contain:
  • Title
  • Abstract
  • Any necessary instructions for use:
    • For notebooks with interactivity: a walk-through of typical usage, intended for reviewers to reproduce. *See the “Reproducibility Considerations” page.
• Citation file: CITATION.cff format.
  • See https://citation-file-format.github.io for more information and a tool to create a CITATION.cff file online
• LICENSE: include a software license with at least enough permissions for the US-RSE organization to publish in the US-RSE’24 conference proceedings.
• Environment file(s) in any of the following formats:
  • environment.yml (Python/Conda and R/Conda)[RECOMMENDED]
  • requirements.txt (Python/pip)
  • install.R and optionally runtime.txt (R/MRAN)
  • DESCRIPTION and optionally runtime.txt (R/MRAN)
• Optional: Additional packaging file to set up your own local library
  • pyproject.toml / setup.py (Python)