treams.io.save_hdf5

treams.io.save_hdf5(h5file, tms, name='', description='', keywords='', embedding_group=None, embedding_name='', embedding_description='', embedding_keywords='', uuid=None, uuid_version=4, lunit='nm')

Save a set of T-matrices in a HDF5 file.

With an open and writeable datafile, this function stores the main parts of as T-matrix in the file. It is left open for the user to add additional metadata.

Parameters:

  • h5file (h5py.Group) – A HDF5 file opened with h5py.

  • tms (TMatrix, array_like) – Array of T-matrix instances.

  • name (str) – Name to add to the file as attribute.

  • description (str) – Description to add to file as attribute.

  • keywords (str) – Keywords to add to file as attribute.

  • embedding_group (h5py.Group, optional) – Group object for the embedding material, defaults to “/materials/embedding/”.

  • embedding_name (string, optional) – Name of the embedding material.

  • embedding_description (string, optional) – Description of the embedding material.

  • embedding_keywords (string, optional) – Keywords for the embedding material.

  • uuid (bytes, optional) – UUID of the file, a new one is created if omitted.

  • uuid_version (int, optional) – UUID version.

  • lunit (string, optional) – Length unit used for the positions and (as inverse) for the wave number.