simdb.cli.commands.utils module¶

simdb.cli.commands.utils.print_simulations(simulations: list[Simulation], verbose: bool = False, metadata_names: list[str] | None = None, show_uuid: bool = False) → None[source]¶

Print a table of simulations to the console.

By default, only the simulation alias is printed on each row. If verbose is True then the simulation datetime and status are also printed and metadata_names allows additional columns to be specified.

Parameters:¶

simulations: list[Simulation]¶

The simulations to print.

verbose: bool = False¶

Whether to print a more verbose table.

metadata_names: list[str] | None = None¶

Additional metadata fields to print as extra columns.

show_uuid: bool = False¶

Whether to include UUID column.

Returns:¶

None

simdb.cli.commands.utils.print_trace(trace_data: dict) → None[source]¶

Print the simulation trace data to the console.

Parameters:¶

trace_data: dict¶

A dictionary containing the simulation trace data.

Returns:¶

None