holodeck.librarian.combine

Combine output files from individual simulation runs into a single library hdf5 file.

This file can be executed as a script (see the main() function), and also provides an API method (sam_lib_combine()) for programatically combining libraries.

holodeck.librarian.combine.main()[source]

Command-line interface executable method for combining holodeck simulation files.

holodeck.librarian.combine.sam_lib_combine(path_output, log, path_pspace=None, recreate=False, gwb_only=False)[source]

Combine individual simulation files into a single library (hdf5) file.

Parameters:

  • path_output (str or Path,) – Path to output directory where combined library will be saved.

  • log (logging.Logger) – Logging instance.

  • path_sims (str or None,) – Path to output directory containing simulation files. If None this is set to be the same as path_output.

  • path_pspace (str or None,) – Path to file containing _Param_Space subclass instance. If None then path_output is searched for a _Param_Space save file.

Returns:

lib_path – Path to library output filename (typically ending with ‘sam_lib.hdf5’).

Return type:

Path,