Misc#
Beyond the scope of the sub-packages, there are many utilities and extensions that are helpful but are not part of the sub-package implementations. This section outlines them.
Utilities (utils)#
The utils module has been organized into submodules for better maintainability:
Module |
Description |
|---|---|
|
File I/O utilities (get_filesize, checksum, temporary files) |
|
Download and network utilities (download_file, DownloadFileManager) |
|
HDF5-specific utilities (has_datasets, has_groups, version groups) |
|
String utilities (remove_special_chars) |
|
Docstring parsing utilities (DocStringParser, deprecated decorator) |
For backward compatibility, all utilities are still available from h5rdmtoolbox.utils:
from h5rdmtoolbox import utils
# These are all still available (re-exported from submodules)
utils.generate_temporary_filename()
utils.has_datasets(h5_file)
utils.DownloadFileManager()
Note
The submodule structure was introduced in v2.7.x. The re-exports in
h5rdmtoolbox.utils will be removed in v3.0.0. Import from submodules
for new code.
Key Utilities#
Generates a temporary filename in user tmp file directory. |
|
|
Check if file has datasets. |
|
Check if file has groups. |
Manager for downloading files. |
Identifiers#
Learn about persistent identifiers for datasets.
Extensions#
Xarray extensions for unit handling and more.
Visualization#
Tools for visualizing HDF5 data.
Time Handling#
Utilities for working with dates and times.
User Directories#
Managing user-specific configuration directories.
File Properties#
Working with HDF5 file properties.
SPARQL Queries#
Querying HDF5 metadata with SPARQL.