Metadata-Version: 2.1
Name: h5ui
Version: 0.1.7
Summary: Terminal User interface for HDF5 file inspection.
Author-email: Rik Huygen <rik.huygen@kuleuven.be>
License: MIT Licence
Project-URL: repository, https://github.com/rhuygen/hdf5_ui
Keywords: HDF5,Terminal
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: textual
Requires-Dist: textual-imageview
Requires-Dist: h5py
Requires-Dist: pillow
Requires-Dist: natsort
Provides-Extra: dev
Requires-Dist: textual-dev ; extra == 'dev'
Provides-Extra: rel
Requires-Dist: build ; extra == 'rel'
Requires-Dist: twine ; extra == 'rel'

# A Terminal User Interface for inspecting HDF5 files

This App is developed with [Textual](https://www.textualize.io).

![](https://raw.githubusercontent.com/rhuygen/hdf5_ui/develop/docs/images/h5tui_ex01.png)
![](https://raw.githubusercontent.com/rhuygen/hdf5_ui/develop/docs/images/h5tui_ex03.png)

# Feature

This TUI is currently in beta and lacks a lot of features. Following is a list implemented features:

- Press 'p' and 'n' to load the 'previous' or 'next' HDF5 file. This is useful when inspecting a range of HDF5 files at the same location and you want to quickly browse through them.
- Content of the HDF5 file is reflected in the tree structure at the left. 
- If a node has attributes attached, they will be displayed at the bottom-left when the node is highlighted.
- Plugins:
  - The App loads all known plugins at startup and uses these plugins to visualize the information they can handle.
  - Two example plugins have been included: HexViewer, and ImageViewer.

# License

This App is distributed under the MIT license.
