HiPerCH 16 / HeFDI Code School: Principles of Research Software Engineering

HiPerCH 16 / HeFDI Code School: Principles of Research Software Engineering

In this year's High Performance Computing in Hessen workshop (HiPerCH 16), HKHLR collaborates with Hessian Research Data Infrastructures (HeFDI) to conduct one of their HeFDI Code School events.

Sustainability, maintainablilty, testability and ease of use of research software, while gaining importance, often fall short in scientific practice. Applying principles of software engineering and design can greatly improve software quality, thereby enabling others to readily use it, to understand and reproduce results. Ultimately, this enhances the overall scientific quality of the published results.

In this course, we dive into the practical aspects of software engineering and design specifically tailored for scientific software, in order to make it more extensible, maintainable and testable. The principles we discuss can be applied to various types of codes such as software for numerical simulation as well as scripts for data processing.

We take the viewpoint of an academic software developer that is exposed to an existing code base with the task to add further functionality. Approaches to dealing with common obstacles like missing tests, interposed functional aspects and inherited technical dept will be discussed. Based on the lessons learned, we also explore how to structure and deploy software used for e.g. data processing.

During practical hands-on sessions, participants will interactively learn how to utilize software development techniques to tackle the aforementioned issues in practice in order to enhance the quality and reproducibility of their software.

This workshop will be held as a hybrid event at the TU Darmstadt.

Registration (On-Site - limited to 20 attendees)

Click here to register.
 

Registration (Online)

Click here to register.

Agenda

Day 1

  • Introduction
  • OOP in Python
  • Usage and importance of version control system git
  • Software design principles for modular and testable code
  • Practical Exercise

Day 2

  • Code refactoring
  • Practical application of design principles in different example codes
  • Practical Exercise
  • Testing and validation techniques

Day 3

  • Test automation
  • Practical Exercise: Knowledge Transfer

Prerequisites

  • The workshop is designed for any users and authors of research software. No knowledge of high performance computing is necessary.
  • Participants need a working knowledge of writing and reading Python code.
  • Bring your own device with a working Python installation (preferably Python >= 3.11).