Learning Objectives
- Audit an existing research repository for reproducibility gaps.
- Package the workflow using containers and parameterized configs.
- Implement automated tests and CI checks to validate outputs.
Reproducible Research Sprint
A 3–4 week residency where student teams refactor an existing research codebase into a reproducible, containerized workflow with CI checks.
Project Overview
Great for advanced undergraduate courses, REU programs, or capstone studios focusing on open science practices.
3–4
Weeks
Git
Workflow Focus
Team
2–3 Researchers
Lesson Snapshot
Standards Alignment
- ACM/IEEE CS Curriculum: Software Engineering + DevOps competencies.
- NSF REU expectations for research rigor and documentation.
- FAIR data principles for open science artifacts.
Suggested Timeline
Week 1
Repository Audit
Teams select a codebase, map dependencies, and document pain points.
- Deliverable: audit log + reproducibility scorecard
- Workshop: container basics + decision tree
Week 2
Containerization
Students create Docker/Singularity images, parameterize configs, and script data pulls.
- Deliverable: working container + README updates
- Mentor check-in: run-through on clean machine
Week 3–4
Automation + Publication
CI workflows validate runs, students finalize documentation, and publish artifacts.
- Deliverable: CI badge + tagged release
- Showcase: lightning talk + poster
Materials & Supports
Checklist
Reproducibility Audit
Guided rubric covering dependencies, data, configuration, and documentation.
Editable Google Sheet
Templates
Container + CI
Dockerfiles, Singularity recipes, and GitHub Actions workflows.
Python + C++ examples
Mentor
Partner Labs
Optional pairing with CS² researchers for office hours and code review.
Requires intake form
Assessment & Deliverables
Artifacts
- Tagged release + GitHub Discussions summary.
- Technical brief describing refactor decisions.
- Short demo video walking through CI results.
Evaluation
- Rubric criteria: reproducibility, documentation, collaboration, and impact.
- Peer assessment focusing on communication + division of labor.
- Mentor endorsement for standout teams.
Download Requests
Contact CS² to access the full sprint package, including template repositories and audit tools.
Bundle
Sprint Playbook
Facilitator agenda, pacing suggestions, and communication templates.
Repo
Template Repositories
Starter projects with container, CI, and documentation scaffolding.