[add]: docstring for h5reader.py

pafsim/signal_generator/h5reader.py

@@ -2,12 +2,30 @@
 
 import h5py
 
-
 def open_hdf5_file(filename):
+    '''
+    Open hdf5 file
+
+    arguments
+        filename of the hdf5 file
+
+    returns
+        h5py.File object
+    '''
     return h5py.File(filename)
 
 
 def get_item_by_path(dataset, path):
+    '''
+    Get item by path
+
+    arguments
+        dataset: h5py.File object
+        path: path of the item
+
+    returns
+        item
+    '''
     indice = path.split('/')
     indice_length = len(indice)
     try:
@@ -31,6 +49,15 @@ def get_item_by_path(dataset, path):
     return dataset
 
 def get_structure_tree(h5_object):
+    '''
+    Get structure tree of the hdf5 file
+
+    arguments
+        h5_object: h5py.File object
+
+    returns
+        string representation of the structure tree
+    '''
     def print_attrs(name, obj):
         nonlocal string_pointer
         level = name.count('/')