Skip to main content

Command-line interface to preview HDF5 files

Project description

Show H5

A simple python-based command-line interface for previewing the contents of HDF5 files, with various levels of detail.

PyPi

Source code

Install

pip install show_h5

Command line usage

Once installed, you'll have a command line interface to view the contents of your HDF5 files.

Basic use: show_h5 FILENAME

View usage: show_h5 -h or show_h5 --help

The following flags are also provided:

  • --section SECTION: View only the contents of the HDF5 group/dataset within the file
  • --show_attrs: Show the attributes of the datasets (if not used, defaults to not showing attributes)
  • --show_data SHOW_DATA: How much data to show in datasets: "none", "some", or "all".
    • "none": [default] Show only the name, shape, and type of the data
    • "some": Show the default amount of the data that numpy shows with a print statement
    • "all": Show all the data. Warning: this may blow up with large datasets.

API usage

from show_h5 import print_h5
print_h5(h5_filename, section=None, show_attrs=False, show_data=False)

Parameters

  • h5_filename: (str) Name/location of the file to show
  • section: (str, optional) Group or dataset of the file to show (the default is None, which shows the contents of the whole file)
  • show_attrs: (bool, optional) Whether to show dataset attributes (the default is False, which only shows dataset contents)
  • show_data: (one of: ["some", "none", "all"], optional) How much data to show in datasets.
    • "none": [default] Show only the name, shape, and type of the data
    • "some": Show the default amount of the data that numpy shows with a print statement
    • "all": Show all the data. Warning: this may blow up with large datasets.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for show-h5, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size show_h5-0.2.1-py3-none-any.whl (4.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size show_h5-0.2.1.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page