Skip to main content

A tool to view HDF5 file structures in the terminal.

Project description

h5forest

PyPI version PyPI downloads Python versions License: GPL v3 Test Suite codecov Code style: ruff

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 vim motions (I use Neovim by the way...).

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" - Previous supervisor.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

h5forest-0.9.0b0.tar.gz (165.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

h5forest-0.9.0b0-py3-none-any.whl (69.4 kB view details)

Uploaded Python 3

File details

Details for the file h5forest-0.9.0b0.tar.gz.

File metadata

  • Download URL: h5forest-0.9.0b0.tar.gz
  • Upload date:
  • Size: 165.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for h5forest-0.9.0b0.tar.gz
Algorithm Hash digest
SHA256 77a7cbb404cc231f693b2a2897979dc9b17da324d97c5df158cad38bc50348df
MD5 b1566878d0834615312d2b378af9767b
BLAKE2b-256 f2e66cce74fb2e9781587fa54e2298bbced625acd0f931ed0d4f168c875419e1

See more details on using hashes here.

File details

Details for the file h5forest-0.9.0b0-py3-none-any.whl.

File metadata

  • Download URL: h5forest-0.9.0b0-py3-none-any.whl
  • Upload date:
  • Size: 69.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.18

File hashes

Hashes for h5forest-0.9.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5939ec700f9d8b26516d0b26b04e534486241270814ddbfc79699933074130e
MD5 5bf4869ce55e438b3287e23de16e6edb
BLAKE2b-256 db688995b1544e5ee1cd928cf2999e24af64c4d712c75a56725c35cb68707229

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page