Scientific Reports (Feb 2024)

Bashing irreproducibility with shournal

  • Tycho Kirchner,
  • Konstantin Riege,
  • Steve Hoffmann

DOI
https://doi.org/10.1038/s41598-024-53811-9
Journal volume & issue
Vol. 14, no. 1
pp. 1 – 7

Abstract

Read online

Abstract Arguably, the most important tool for many computational scientists is the Linux shell. Processing steps carried out there are critical for a large number of analyses. While the manual documentation of the work is time-consuming and error-prone, existing tools do not integrate well into the shell or suffer from a large overhead. Here, we present shournal, which integrates tightly into the shell and automatically records all shell commands along with their associated file events. Thus, for all files, it can later be told how they were generated and processed. Additionally, it allows the creation of detailed reports for whole project folders. shournal retrieves its data directly from the Linux kernel and allows the monitoring of whole process trees with low overhead.