Software development - Good Practices and Tips

Note

RSE training sessions for first year CDT Fluid Dynamics students

Suggested Agenda

Day 1

Time	Agenda
1000	Software Dev. Life Cicle
1100	Break
1110	Open and Reproducible Work: Tips & Tools
1200	Lunch
1300	Intro to Version Control
1450	Break
1500	GitHub
1600	Close

Day 2

Time	Agenda
1000	Defensive programming
1100	Break
1110	Test driven development
1200	Lunch
1300	Project
1450	Break
1500	Project
1600	Close

The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.

Additional Material

• Slides

• Demo Repository

• Alan Turing Institute RSE Course Material

Instructors

• Principal Instructor: Dr Patricia Ternes

• Assistant Instructors: Research Computing Team

Content

• Setup
• Software development in a nutshell
  • Software Development Life Cycle
  • Project management methodologies
  • Tasks & Kanban
  • Package managers
  • Laying out a coding project
  • Additional tips
• Introduction to Version Control
  • What is Version Control and why do I need it?
  • Creating a local repository
  • Tracking Changes
  • Exploring History
  • Ignoring Things
  • Branching
  • Git glossary
• Github
  • Github repository
  • Synchronizing: Local & GitHub
  • Synchronizing: Visual Studio Code way
  • GitHub issues
• Defensive programming
  • Python Errors
  • Assertions
• Test driven development
  • Testing
  • Test-driven development
  • Unit testing
• Bringing it all together
  • Case of study