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.7.0b0.tar.gz (100.6 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.7.0b0-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for h5forest-0.7.0b0.tar.gz
Algorithm Hash digest
SHA256 5fd62c959703fac9a8915d7903ce6df7b70f07083b8428cdc2ef01a462d44dd0
MD5 ccf31c1ac6abd9cfd21a8a20ef7f3ab6
BLAKE2b-256 21dc65c9bc8293ea69c0157fa64c1e6b89855b8e94481efdedc922fc04e3818c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: h5forest-0.7.0b0-py3-none-any.whl
  • Upload date:
  • Size: 57.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.7.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecd666f3b0338097a63d95cd7b85284900fbaa2ef33afdc10b227d48417e8c05
MD5 340ad4c167327157e1c0ac317a878ef9
BLAKE2b-256 762601e38e4940a84a8f1aa6f47d1ebf7bb3b26f56c86ac71c665e5a855472ad

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