Overview
A FAIR lesson plan for trainers and educators.
Topic, definition and scope
- Licences
- Public software repositories
- Documentation
- Modular scripting
- Version control
- Virtual environments
- (Automated) testing
Exercises
- How might a virtual environment (e.g., venv, renv) enhance re-usability?
- What factors might determine whether you create automated tests for research software?
Recommended reading
- A large-scale study on research code quality and execution (Trisovic et al., 2022)
Learning outcomes
-
1
Understand the benefits of virtual environments for reusability.
-
2
Have sufficient understanding of modular scripting to identify it within a repository and translate a single (large) script into multiple (smaller) modules.
-
3
Define version control and have a basic understanding of how git operates.
-
4
Be able to critically assess whether automated testing might be worth implementing for a research software project.
Lesson agenda
0 activities · 0 min total · grouped by phase
0:00
End of phase · 0 min
0:00
End of phase · 0 min
0:00
End of phase · 0 min
Summary of tasks and actions
No separate task summary is stored yet. The activity agenda above is the current source for trainer actions.
Materials and equipment
- For participants
- Not specified yet.
- For the trainer
- Not specified yet.
No additional resources have been added yet.
CITE THIS LESSON PLAN
Pronk T, Langton S. Reusable Software. Version 1.0. FAIR Lesson Plan Handbook [Internet]. 2026. Available from: https://doi.org/10.5072/zenodo.627833