Reads Hydrological Simulation Program - FORTRAN binary output files.
Project description
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.7 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)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hspfbintoolbox-9.0.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 13132120c0b55788461cd34afe042fde1ad50a34a1e3e74542dee09b06aa2e39 |
|
| MD5 | ca0c9b022ae0dba14a6d2f04cf986d47 |
|
| BLAKE2b-256 | 690d5963d39a5465110d532447b4b1ba32cddf0ada20cfc2fbd3ea57ae17adf9 |
