matlab-h5-tools

High level tools for working with HDF5 files in MATLAB
38 Downloads
Updated 4 Jun 2023

Matlab H5 Tools

View matlab-h5-tools on File Exchange test workflow codecov

Overview

Matlab H5 Tools provides a collection of tools for working with Hierarchical Data Format version 5 (HDF5) files. MATLAB already provides excellent support for HDF5 files with both high-level and low-level access functions. The primary purpose of this library is to provide additional high-level functions that simplify actions that are currently only supported via the low-level interface.

The project also serves as a simple example of a MATLAB toolbox that uses the MATLAB class-based unit testing framework with continuous integration and code coverage running automatically using GitHub actions.

Installation

The tools can be installed directly from the MATLAB Add-On Explorer. Select Add-Ons and search for Matlab H5 Tools, then select Add, Add to MATLAB.

Usage

The functions are contained within the h5tools namespace. After installing, the functions can be called by pre-pending the namespace, e.g., h5tools.copyGroup(...).

Tests

Tests are written using the MATLAB testing framework and are contained in the tests folder (this is only visible if cloning from GitHub, rather than installing from MATLAB). The tests are executed automatically every push to the repository. The tests can be executed locally using runtests('path/to/matlab-h5-tools/tests');.

Related tools

There are many excellent related projects on GitHub with similar goals. In particular, h5tools-matlab has a very extensive set of high-level tools.

Cite As

Bradley Treeby (2024). matlab-h5-tools (https://github.com/btreeby/matlab-h5-tools/releases/tag/v1.1.0), GitHub. Retrieved .

MATLAB Release Compatibility
Created with R2023a
Compatible with any release
Platform Compatibility
Windows macOS Linux
Tags Add Tags

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

+h5tools

+h5tools/private

Version Published Release Notes
1.1.0.0

See release notes for this release on GitHub: https://github.com/btreeby/matlab-h5-tools/releases/tag/v1.1.0

1.0.0

To view or report issues in this GitHub add-on, visit the GitHub Repository.
To view or report issues in this GitHub add-on, visit the GitHub Repository.