[MNT] - Update to the 'h5' instead of 'hdf5'

doc/api.rst

@@ -32,7 +32,7 @@ NWB file I/O
 HDF5 file I/O
 ~~~~~~~~~~~~~
 
-.. currentmodule:: hsntools.io.hdf5
+.. currentmodule:: hsntools.io.h5
 .. autosummary::
    :toctree: generated/
 

hsntools/io/hdf5.py → hsntools/io/h5.py

@@ -1,4 +1,7 @@
-"""File I/O for HDF5 files, including context managers."""
+"""File I/O for HDF5 files, including context managers.
+
+Functionality in this file requires the `h5py` module: https://github.com/h5py/h5py
+"""
 
 from contextlib import contextmanager
 

hsntools/io/nsp.py

@@ -1,4 +1,7 @@
-"""Neural Signal Processor (NSP) related I/O functions."""
+"""Neural Signal Processor (NSP) related I/O functions.
+
+Functionality in this file requires the `neo` module: https://github.com/NeuralEnsemble/python-neo
+"""
 
 from hsntools.io.utils import check_folder
 from hsntools.modutils.dependencies import safe_import, check_dependency

hsntools/io/nwb.py

@@ -1,4 +1,8 @@
-"""Helper utilities for validating NWB files."""
+"""Helper utilities for validating NWB files.
+
+Functionality in this file requires the `pynwb` module:
+https://github.com/NeurodataWithoutBorders/pynwb
+"""
 
 from hsntools.io.utils import check_ext, check_folder, make_session_name
 from hsntools.modutils.dependencies import safe_import, check_dependency

hsntools/io/sorting.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 
 from hsntools.io.utils import get_files
-from hsntools.io.hdf5 import open_h5file, save_to_h5file, load_from_h5file
+from hsntools.io.h5 import open_h5file, save_to_h5file, load_from_h5file
 
 ###################################################################################################
 ###################################################################################################

hsntools/tests/conftest.py

@@ -11,7 +11,7 @@
 
 import pytest
 
-from hsntools.io.hdf5 import open_h5file
+from hsntools.io.h5 import open_h5file
 from hsntools.objects.task import TaskBase
 from hsntools.objects.electrodes import Bundle, Electrodes
 from hsntools.tests.tsettings import BASE_TEST_OUTPUTS_PATH, TEST_PATHS, TEST_SORT

hsntools/tests/io/test_hdf5.py → hsntools/tests/io/test_h5.py

@@ -1,12 +1,12 @@
-"""Tests for hsntools.io.hdf5"""
+"""Tests for hsntools.io.h5"""
 
 import os
 
 import numpy as np
 
 from hsntools.tests.tsettings import TEST_FILE_PATH
 
-from hsntools.io.hdf5 import *
+from hsntools.io.h5 import *
 
 ###################################################################################################
 ###################################################################################################