Duration: 4 half days
Pre-requisites:
- Be comfortable using the Python interpreter from the command line and understand basic Python (e.g. writing loops, using functions and libraries).
- Be able to use Git for version control via the command line (e.g. clone, add, commit, push, and pull with GitHub).
This four half-day course teaches researchers how to develop high-quality, reproducible research software.
You’ll learn the principles of open and reproducible research and learn how to apply these to your code with the help of various tools and techniques. We’ll cover how to work in Python virtual environments and how to write clean, maintainable code through meaningful naming, reusable functions, and proper documentation. You’ll use GitHub’s collaborative features including issue tracking, branching, and pull requests to manage development and work effectively with others.
The course also covers automated testing using pytest to ensure your software behaves as expected, and documentation best practices including using MkDocs to create comprehensive project documentation. You’ll learn to archive code on Zenodo and generate DOIs to make your software citable.
This course provides practical skills for building robust, sustainable, and collaborative research software.
Training materials: https://carpentries-incubator.github.io/better-research-software/