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"])
Metadata
Release files for hspf-reader 2.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hspf_reader-2.1.3.tar.gz | 864.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hspf_reader-2.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 928.6 kB
Release files / hspf_reader-2.1.3.tar.gz
| Download URL | hspf_reader-2.1.3.tar.gz |
|---|---|
| Size | 864.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
940df0a3208c1de4da175800283b08c174527998ccba3090e91d45566adfdfb0
|
|
BLAKE2b-256 checksum How to use checksums |
489ae8d2b2c1e6559ae9dd01c71f04241b30908dac15cbe8af682351d32d36f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 11, 2026.
Transparency logRelease files / hspf_reader-2.1.3-py3-none-any.whl
| Download URL | hspf_reader-2.1.3-py3-none-any.whl |
|---|---|
| Size | 64.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
099ddcc51ce8ad95c23f88d6808f9c4b6ae62975273c622044c7d11844c0c5b2
|
|
BLAKE2b-256 checksum How to use checksums |
fcc5a8b5eea1e78f08dfd71251efe68744bc98fa94c39499cfae846865a2b63a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 11, 2026.
Transparency log