hspf-reader 2.0.2

Description:

hspfreader 2.0.2

hspf_reader - Quick Guide
The hspf_reader is a pure Python module and command line script to read HSPF
time-series from WDM files, HSPF binary files, and HSPF plotgen files.
Use “wdmtoolbox” to create, examine, read, and write to WDM files.
Use “hspfbintoolbox” to catalog and read HSPF binary output files.

Installation

pip
pip install hspf_reader


conda
conda install -c conda-forge hspf_reader



Usage - Command Line
Just run ‘hspf_reader –help’ to get a list of subcommands:
usage: hspf_reader [-h]
{wdm, hbn, plotgen, about} ...

positional arguments:
{wdm, hbn, plotgen, about}

wdm
Read HSPF WDM files.
hbn
Read HSPF binary files.
plotgen
Read HSPF plotgen files.
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 hspf_reader:
from hspf_reader import hspf_reader

# Then you could call the functions
ntsd = hspf_reader.wdm('wdm_file.wdm', 202)

# Once you have a PANDAS DataFrame you can use that as input to other
# hspf_reader functions.
ntsd = hspf_reader.hbn('hbn_file.hbn', "yearly", [,,,"TAET"])