polaris.run.results.write_suite_results

polaris.run.results.write_suite_results(filename: str, suite_name: str, provenance: Dict[str, str | None], start_time: datetime, elapsed_seconds: float, task_results: Iterable[TaskResult], complete: bool) → None[source]

Write the machine-readable results of a suite run

The file is written to a temporary file and renamed into place, so a reader never sees a partial file.

Parameters:

  • filename (str) – The results file to write

  • suite_name (str) – The name of the suite, or task for a single task

  • provenance (dict) – Metadata about the run, such as the machine and compiler, with None for anything that is not known

  • start_time (datetime.datetime) – When the suite started running

  • elapsed_seconds (float) – The wall-clock time since the suite started running

  • task_results (iterable of polaris.run.results.TaskResult) – The results of every task in the suite, in the order they run, including those that have not been run yet

  • complete (bool) – Whether the suite has finished running