plumed_bench_pp.tabulate

Functions

convert_to_table(filesdict, rows_to_extract, ...)

Generates a table using the specified rows.
plumed_bench_pp.tabulate.convert_to_table(filesdict: dict[Any, BenchmarkRun] | list[BenchmarkRun], rows_to_extract: list[str], kernel: str, inputlist: str | list[str] | re.Pattern) → dict[str, DataFrame]

Generates a table using the specified rows.

Extracts the specified rows from the given files list or dict, filtering the specified kernel and input files.

Parameters:

  • filesdict (dict | list) – A dictionary containing file data parsed by parse_benchmark_output.()

  • rows_to_extract (list[str]) – A list of strings representing the rows to extract from the files the most common ones are in plumed_bench_pp.constants.

  • kernel (str) – A string specifying the kernel to filter files by.

  • inputlist (str | list[str] | re.Pattern) – A string, list of strings, or regular expression pattern to filter the plumed input files used by the desired kernel.

Returns:

A dictionary containing the table data indexed by report’s rows

Return type:

dict[str, DataFrame]