sidpy.io.nexus.sidpy_to_nexus_hdf5

sidpy.io.nexus.sidpy_to_nexus_hdf5(dataset, h5_path, entry_name='entry', nxdata_name='data', signal_name='data', mode='w', compression=None)[source]

Write a sidpy.Dataset to a NeXus-compatible HDF5 file.

Parameters:

  • dataset (sidpy.Dataset) – Dataset to serialize.

  • h5_path (str or h5py.File) – Destination HDF5 path or open file handle.

  • entry_name (str, optional) – Name of the NXentry group.

  • nxdata_name (str, optional) – Name of the NXdata group.

  • signal_name (str, optional) – Name of the primary signal dataset within NXdata.

  • mode (str, optional) – File mode used when h5_path is a path.

  • compression (str, optional) – Compression passed to h5py when creating datasets.

Returns:

Signal dataset path for path-based writes, or the written h5py.Dataset when an open file handle is provided.

Return type:

str or h5py.Dataset