ProjectPythia / ProjectPythia/pythia-foundations
Add content on best practices for reproducibility with Jupyter Notebooks
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 72
- Forks
- 60
- Avg merge
- 17h 36m
- Merged PRs (30d)
- 2
Description
Pythia’s educational materials cover many of the technologies and practices that are vital to Open Science principles such as transparency, accessibility, and reproducibility. But for a scientist not accustomed with many of these technologies, putting everything together in a way that allows them to create a shareable, reproducible workflow may not be obvious. Pythia should consider adding a section that leverages the Foundations modules and provides more of a step-by-step guide to creating a reproducible workflow with a Jupyter Notebook, backed by GitHub and conda. The guide might include a template repo with a Notebook and conda environment management (a slimmed down version of the cookbook template), and a discussion on best practices.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing Foundations modules and the cookbook template first to understand how educational content and example repositories are organized. Define a step-by-step reproducible-workflow guide using a Jupyter Notebook, GitHub, and conda, optionally with a slimmed-down template repository. Done means the guide covers the proposed best practices and provides a usable example workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100