exosim.utils.output_cleaners#

Functions#

prune_output(out[, logger, folders_to_remove, ...])

It prunes the output file, removing unnecessary data to reduce its size.

Module Contents#

prune_output(out, logger=None, folders_to_remove=None, folders_to_keep=None, root_groups_to_keep=None, compact_file=True)[source]#

It prunes the output file, removing unnecessary data to reduce its size. After pruning, the file is automatically compacted to physically remove deleted data.

Parameters:

  • out (OutputGroup) – output group

  • logger (logger object (optional)) – logger instance for logging messages

  • folders_to_remove (list of str (optional)) – list of folder names to remove entirely from the output (searched recursively)

  • folders_to_keep (list of str (optional)) – list of folder names to keep entirely in the output

  • root_groups_to_keep (list of str (optional)) – list of root-level groups to keep (defaults to standard groups)

  • compact_file (bool (optional)) – if True, recompacts the file after pruning to physically reduce file size (default: True)

Return type:

None