Documentation for hspfbintoolbox
The hspfbintoolbox is a Python script and library of functions to read Hydrological Simulation Program Fortran (HSPF) binary files and print to screen. The time series can then be redirected to file, or piped to other command line programs like tstoolbox.
Requirements
python 3.10 or later
tstoolbox - utilities to process time-series
Installation
pip
pip install hspfbintoolboxconda
conda install -c conda-forge hspfbintoolboxUsage - Command Line
Just run ‘hspfbintoolbox –help’ to get a list of subcommands:
- catalog
Prints out a catalog of data sets in the binary file.
- extract
Prints out data to the screen from a HSPF binary output file.
For the subcommands that output data it 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. Input can be a CSV or TAB separated file, or a PANDAS DataFrame and is supplied to the function via the ‘input_ts’ keyword.
Simply import hspfbintoolbox:
import hspfbintoolbox
# Then you could call the functions
ntsd = hspfbintoolbox.extract('tests/test.hbn', 'yearly', ',905,,AGWS')
# Once you have a PANDAS DataFrame you can use that as input.
ntsd = tstoolbox.aggregate(statistic='mean', agg_interval='daily', input_ts=ntsd)
1 maintainer
Release files for hspfbintoolbox 9.0.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hspfbintoolbox-9.0.12.tar.gz | 35.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hspfbintoolbox-9.0.12-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 54.1 MB
Release files / hspfbintoolbox-9.0.12.tar.gz
| Download URL | hspfbintoolbox-9.0.12.tar.gz |
|---|---|
| Size | 35.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0743d9ab4131b60f1172fa5bad52cb9616e50d73b1bc67e573cc28d30a849510
|
|
BLAKE2b-256 checksum How to use checksums |
d7ea89707d394a0eea30683a92d7ce3d4114a3ac02b78f538a4c7524f4b6041a
|
| 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 23, 2026.
Transparency logRelease files / hspfbintoolbox-9.0.12-py3-none-any.whl
| Download URL | hspfbintoolbox-9.0.12-py3-none-any.whl |
|---|---|
| Size | 18.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c763da21988d4e5d3859f200552dd93c7a6341237a1981c9e041a4fe482e2eca
|
|
BLAKE2b-256 checksum How to use checksums |
82913ab576d24d2ae110ce4d82fdbe2ae2aa16a8d724ada63bd0688a4c382ff2
|
| 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 23, 2026.
Transparency log
