Skip to main content

A tool to view HDF5 file structures in the terminal.

Project description

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

SCR-20241021-belp

The following features are coming soon:

  • A search function.
  • 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.6.1b0.tar.gz (64.8 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.6.1b0-py3-none-any.whl (56.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for h5forest-0.6.1b0.tar.gz
Algorithm Hash digest
SHA256 17c730b16c1ff36055bf50a4dd8a351a1217cdd5a57824614f74117cba678673
MD5 478876f19d307ab5a5843b63c990bdfa
BLAKE2b-256 31dd693f002bc79010447af58aaf6a44356c6dd0d3b2c16263357a52d4aab922

See more details on using hashes here.

File details

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

File metadata

  • Download URL: h5forest-0.6.1b0-py3-none-any.whl
  • Upload date:
  • Size: 56.8 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.6.1b0-py3-none-any.whl
Algorithm Hash digest
SHA256 442cc6bd3c6c043efecb98b7fe6b710aa3f188789f944717aa084536be1ce85d
MD5 2c838b2680d874139695fcaed5f9b1a3
BLAKE2b-256 457c744ee55c176f6485b83f1949771a117088bc032175a57fbdb69a7f80813b

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