Skip to main content

h5forest

PyPI - Version PyPI downloads Python versions License: GPL v3 Contributions welcome Test Suite codecov Code style: ruff pre-commit

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:

SCR-20241021-belp

  • 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.

Metadata

Release files for h5forest 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for h5forest 1.1.0
File Size Uploaded
h5forest-1.1.0.tar.gz 204.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for h5forest 1.1.0
File Interpreter ABI Platform
h5forest-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 298.2 kB

Release files / h5forest-1.1.0.tar.gz

Download URL h5forest-1.1.0.tar.gz
Size 204.6 kB
Tags Source
SHA-256 checksum
How to use checksums
bb80ec6ae2613a0cb353bac426e9356f293340f2e5799cdb4551c86a5d9c3258
BLAKE2b-256 checksum
How to use checksums
242b0649be00f83ca6da5b750f7079de08879308ba95357ed01c74d6794e3804
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.18

Release files / h5forest-1.1.0-py3-none-any.whl

Download URL h5forest-1.1.0-py3-none-any.whl
Size 93.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cd06f734ff35b303bf3745439d86a819094f4e406e7327646dcf80289e399e19
BLAKE2b-256 checksum
How to use checksums
a13eacd557e13a999848860355cc83b0a6ac54069649b66d83532e96e18e118b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.8.18
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page