Tools and good practices (including the FAIR principles) for research software

Online

1 - 4 April 2025

9:15 - 13:00 BST (UTC + 1)

Instructors: Aman Goel, Sam Mangham, Colin Sauze, Philly Broadbent

Helpers: Aleks Nenadic

General Information

This workshop is organised by the Software Sustainability Institute and funded by UK Reproducibility Network (UKRN).

Course material that will be used at the workshop is available online and will remain publicly available after the workshop.

Where: This workshop will take place online via Zoom - the organisers will provide registered participants with the connection information closer to the workshop.

When: 1 - 4 April 2025, 9:15 - 13:00 BST (UTC + 1).

Requirements: Participants must have access to a computer with a Mac, Linux, or Windows operating system (not a tablet, Chromebook, etc.) that they have administrative privileges on. Participants should have a few specific software packages installed - please make sure to follow the setup instructions.

Contact: Please email a.nenadic@software.ac.uk for more information.


Code of Conduct

Everyone who participates in this workshop is required to conform to the Code of Conduct.


Collaborative Notes

We will use this collaborative document for chatting, taking notes, and sharing URLs and bits of code.


Surveys

Please be sure to complete these surveys before and after the workshop.

- Pre-workshop survey

- Post-workshop survey


Schedule

Day 1, 1 April 2025, 09:15 - 13:00 UTC

09:15 Course introduction
09:45 FAIR research software
10:15 Break
10:30 Tools and good practices for software
11:30 Break
11:45 Tools and good practices for software (cont'd)
13:00 End

Day 2, 2 April 2025, 09:15 - 13:00 UTC

09:15 Day 1 recap
09:30 Version control
10:15 Break
10:30 Version Control (cont'd)
11:30 Break
11:45 Reproducible software environments
13:00 End

Day 3, 3 April 2025, 09:15 - 13:00 UTC

09:15 Day 2 recap
09:30 Code readability
10:15 Break
10:30 Code structure
11:30 Break
11:45 Code correctness & testing
13:00 End

Day 4, 4 April 2025, 09:15 - 13:00 UTC

09:15 Day 3 recap
09:30 Software documentation
10:15 Break
10:30 Software documentation (cont'd)
11:30 Break
11:45 Open software management & collaboration
13:00 Wrap-up/End

Setup

Please make sure that you have all the required software installed before coming to the workshop. If you are having installation or setup problems - please contact the workshop organisers who will be able to assist you. Failing to have a working setup on your machine will slow everyone down at the workshop.