hsp2_reader - Quick Guide

The hsp2_reader is a pure Python module and command line script to read HSP2 time-series from HDF5 files.

Installation

pip

pip install hsp2_reader

conda

conda install -c conda-forge hsp2_reader

Usage - Command Line

Just run ‘hsp2_reader –help’ to get a list of subcommands:

usage: hsp2_reader [-h]
                 {hsp2, about} ...

positional arguments:
  {hsp2, about}

hdf5
    Read HSP2 results from HDF5 file.
about
    Display version number and system information.

optional arguments:
  -h, --help            show this help message and exit

The output time-series data is printed to the screen and you can then redirect to a file.

Usage - API

You can use all of the command line subcommands as functions. The function signature is identical to the command line subcommands. The return is always a PANDAS DataFrame.

Simply import hsp2_reader:

from hsp2_reader import hsp2_reader

# Then you could call the function
ntsd = hsp2_reader.hdf5("file.h5", "yearly", [,,,"TAET"])