Contribution to a conference proceedings/Contribution to a book

FZJ-2025-01971

http://join2-wiki.gsi.de/foswiki/pub/Main/Artwork/join2_logo100x88.png A concise guide to good practices for automated testing and documentation of Research Software

Fritz, J. (Corresponding author)FZJ* ; Mesiti, M. ; Thiele, J. P.

2025
Techn. Univ. Berlin

This record in other databases:

Please use a persistent id in citations: doi:10.14279/ECEASST.V83.2622  doi:10.14279/eceasst.v83.2622  doi:10.34734/FZJ-2025-01971

Abstract: This publication aims to highlight aspects of good practices from the areas of testing, documentation, and workflow management to improve existing code in Research. Applying these practices helps to make the scientific results obtained with the software easier to reproduce, as the codebase is easier to understand (thanks to documentation) and it is ensured that the code works as expected (thanks to automated testing). As codebases grow larger, workflow management for automated testing is also needed in order to keep the development cycle fast.

Keyword(s): Ci ; documentation ; testing ; workflows ; RSE

---

Contributing Institute(s):

1. Jülich Supercomputing Center (JSC)

Research Program(s):

1. 5112 - Cross-Domain Algorithms, Tools, Methods Labs (ATMLs) and Research Groups (POF4-511) (POF4-511)
2. RGRSE - RG Research Software Engineering for HPC (RG RSE) (RG-RSE) (RG-RSE)
3. HiRSE_PS - Helmholtz Platform for Research Software Engineering - Preparatory Study (HiRSE_PS-20220812) (HiRSE_PS-20220812)

Appears in the scientific report 2025

---

Database coverage:
;

---