combine_h5

ssapy.io.combine_h5(filename, files, verbose=False, overwrite=False)[source][source]

Combine multiple HDF5 files into a single HDF5 file.

This function reads datasets from a list of HDF5 files and writes them to a specified output HDF5 file. If overwrite is True, it will remove any existing file at the specified filename before combining the files. The verbose parameter, if set to True, will display progress bars during the process.

Parameters:

filenamestr: The path to the output HDF5 file where the combined datasets will be stored.
fileslist of str: A list of paths to the HDF5 files to be combined.
verbosebool, optional: If True, progress bars will be displayed for the file and key processing. Default is False.
overwritebool, optional: If True, any existing file at filename will be removed before writing the new combined file. Default is False.

Returns:

None: The function performs file operations and does not return any value.

Examples:

>>> combine_h5('combined.h5', ['file1.h5', 'file2.h5'], verbose=True, overwrite=True)