utils.delete_hdf5_datasets#

Back to Module page

Summary#

Convenience function to prune some leaves from a hdf5 file

Signature#

def delete_hdf5_datasets(source, h5path, leaves)
Input variables#

Name

Type

Default

Description

source

Path to the hdf5 file, or the file object itself

h5path

String, or an iterable of strings to reach the parent of the leaves

leaves

String, or iterable of strings with names of leaves to delete

Output variables#

Return annotation

Docstring type

Description

None

Docstring#

Convenience function to prune some leaves from a hdf5 file
:param source: Path to the hdf5 file, or the file object itself
:param h5path:
    String, or an iterable of strings to reach the parent of the leaves
:param leaves: String, or iterable of strings with names of leaves to delete
:return: