Skip to main content

Module run_report

Module run_report 

Source
Expand description

The run report (D103): how a run went, written to a separate JSON file (schemas/run-report.schema.json) so that the results stay byte-identical across runs.

It records what an audit needs: version and build target, the command (rebuilt from the parameters, file names only), status, UTC times, threads and where their number came from, platform, phase times, CPU time, peak memory, and the size and SHA-256 of every input and output. It never records anything that identifies a person or machine: no host or user names, no directories, no environment values, no raw command line (data minimisation, GDPR art. 5 and 25). Field names follow the Workflow Run RO-Crate terms (Leo et al. 2024) so a Process Run Crate export can follow.

Front ends fill it: the CLI (--run-report) and the desktop app (“Save run report…”).

Structs§

FileRecord
An input or output file.
PhaseTime
Wall time of one phase.
Platform
Operating system and processor.
Resources
Time and memory used.
RunReport
The run report. Serialised in field order.
Threads
Worker threads and where their number came from (D101).
Tool
The program that ran.
Work
Amount of work done.

Enums§

Status
How the run ended.

Constants§

REPORT_SCHEMA_VERSION
Version of the run-report schema.

Functions§

error_text
The error text a run report records: the first line of the message (later lines can list input data such as FASTA headers), every cause and the hint, with directories removed (redact_paths; known are the paths given to the program).
file_name
A path reduced to its file name (no directories), - for standard streams and descriptor paths such as /dev/fd/63 (process substitution).
redact_paths
message with every path reduced to its file name, so error texts in the run report hold no directories (D103): first the paths given on the command line (known, longest first), then any quoted path, then any bare absolute path (e.g. in an operating-system message).
rfc3339
2026-10-05T08:12:01.123+00:00 (RFC 3339, UTC, milliseconds).