h5forest 1.0.0

A tool to view HDF5 file structures in the terminal.

h5forest

HDF5 Forest (h5forest) is a Text-based User Interface (TUI) for exploring HDF5 files.

h5ls works, and h5glance is a great improvement, so "Why bother?" I hear you ask.

Well, h5forest brings interactivity and new functionality not available in its long-standing brethren. h5forest includes:

• An interactive interface capable of handling large files with deep hierarchies.
• Fully asynchronous operation for a blazingly fast (🔥) and responsive feel.
• A real-time metadata and attribute display.
• Memory efficiency with lazy loading.
• Peeking inside Datasets.
• On-the-fly statistics.
• Fuzzy search with real-time filtering to quickly find datasets and groups.
• A fully terminal-based interface with optional vim-style navigation (configurable in ~/.h5forest/config.yaml).

For more details read the documentation for installation, usage guides, and examples.

Getting started

h5forest can be installed through pip:

pip install h5forest

You will now have the h5forest command installed. Simply run

h5forest /path/to/hdf5/file.hdf5

on the command line to get started exploring a file.

Testimonials

"This is the most compelling and useful procrastination I've ever seen" - Frustrated collaborator waiting for actual work to be done.

"Why has no one done this before? Let’s nominate him for a peerage." - Professor incapable of peerage nomination.

"Nice" - PhD supervisor.