sidpy.hdf.prov_utils.create_results_group¶
- sidpy.hdf.prov_utils.create_results_group(h5_main, tool_name, h5_parent_group=None)[source]¶
Creates a h5py.Group object auto-indexed and named as ‘DatasetName-ToolName_00x’
- Parameters:
h5_main (h5py.Dataset object) – Reference to the dataset based on which the process / analysis is being performed
tool_name (string / unicode) – Name of the Process / Analysis applied to h5_main
h5_parent_group (h5py.Group, optional. Default = None) – Parent group under which the results group will be created. Use this option to write results into a new HDF5 file. By default, results will be written into the same group containing h5_main
- Returns:
h5_group – Results group which can now house the results datasets
- Return type: