perun.io.text_report

Text report module.

Attributes

Functions

textReport(dataNode, mr_id) → str

Create text report from selected MULTI_RUN node.

sensors_table(sensors[, by_rank]) → str

Create a text table from a list of sensor readings.

Module Contents

perun.io.text_report.log[source]
perun.io.text_report.DEFAULT_TABLE_METRICS
perun.io.text_report.DEFAULT_REGION_METRICS
perun.io.text_report.textReport(dataNode: perun.data_model.data.DataNode, mr_id: str) → str[source]

Create text report from selected MULTI_RUN node.

Parameters:
  • dataNode (DataNode) – Application data node

  • mr_id (str) – Multirun id

Returns:

Report string

Return type:

str

perun.io.text_report.sensors_table(sensors: list[dict[str, Any]], by_rank: bool = True) → str[source]

Create a text table from a list of sensor readings.

Parameters:
  • sensors (list[dict[str, Any]]) – List of sensor readings

  • by_rank (bool, optional) – If the table should separate available sensors by rank.

Returns:

Table string

Return type:

str