internal.files

Internal functions for file manipulation.

bpreveal.internal.files.addH5Metadata(h5fp, **kwargs)

Adds some metadata to your hdf5 file for reproducibility.

Parameters:

  • h5fp (File) – The opened hdf5 file that you want to add metadata to. This file must be opened for writing.

  • kwargs (str) – The attributes you want to store.

Return type:

None

This will create a group called metadata and it will store everything listed in kwargs. It also stores the BPReveal version in bpreveal_version, and the date of creation in created_date.