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:

  • An interactive interface capable of handling large files with deep hierarchies.
  • Real-time metadata and attribute displays.
  • A modal system for interacting with the file (I use Neovim by the way).
  • Lazy loading, making the most of chunked data.
  • Peeking inside Datasets.
  • Computing statistics on the fly.
  • Generation of quick diagnostics.
  • Fully asynchronous operation for a blazingly fast (🔥) and responsive feel.
  • A fully terminal-based interface with vim motions (did I mention?...).
  • Fuzzy search with real-time filtering to quickly find datasets and groups.

SCR-20241021-belp

The following features are coming soon:

  • Renaming of Datasets and Groups.

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.8.0b0.tar.gz (147.4 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.8.0b0-py3-none-any.whl (63.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for h5forest-0.8.0b0.tar.gz
Algorithm Hash digest
SHA256 f04f5fc048b05eb2644b5b41830d73a0604f53d72f15e4fec60b26722d219733
MD5 317a922458d4f80b7581525a0009caba
BLAKE2b-256 59f26bb1d8797f255e8a8471363c8e27ad4b62a30c29cedc34ff90564e21587a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: h5forest-0.8.0b0-py3-none-any.whl
  • Upload date:
  • Size: 63.2 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.8.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 23eb15dcc53962f755c7a4bf6e56ac58bec4b423be35b895d627dfbdd06121c2
MD5 ac92ebebfdeb7417af49185f1cf378c8
BLAKE2b-256 7bbd9104728dae0f771c71311b4ea87b1a2917c1926ced40e66745deda924513

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