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" - PhD 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.1.tar.gz (153.2 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.1-py3-none-any.whl (71.3 kB view details)

Uploaded Python 3

File details

Details for the file h5forest-0.9.1.tar.gz.

File metadata

  • Download URL: h5forest-0.9.1.tar.gz
  • Upload date:
  • Size: 153.2 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.1.tar.gz
Algorithm Hash digest
SHA256 c91eaf7ea5549b460755afd5f7ebea9a317c96cf262d3c9c9186c65ae2813992
MD5 7bc873dabc6e236263c035927f59e49f
BLAKE2b-256 75817ae35760980a3d8f80e48db05af96b05654607d192cda56a581c1bb99d41

See more details on using hashes here.

File details

Details for the file h5forest-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: h5forest-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 71.3 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 04a66457c00c5fd0649c539302f205e7b11a08e7aefc81cc6af5d17c7a9c9532
MD5 c55590bac544038f14846ecc78e2ee6c
BLAKE2b-256 a127c1ace54e08ee2a3a8a7f980a6a575a7c842f8ba86e0e1f09d3f855460f8d

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