Skip to main content

Reads Hydrological Simulation Program - FORTRAN binary output files.

Project description

Tests Test Coverage Latest release BSD-3 clause license hspfbintoolbox downloads PyPI - Python Version

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 hspfbintoolbox

conda

conda install -c conda-forge hspfbintoolbox

Usage - 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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hspfbintoolbox-9.0.7.tar.gz (17.2 MB view details)

Uploaded Source

Built Distribution

hspfbintoolbox-9.0.7-py3-none-any.whl (63.7 kB view details)

Uploaded Python 3

File details

Details for the file hspfbintoolbox-9.0.7.tar.gz.

File metadata

  • Download URL: hspfbintoolbox-9.0.7.tar.gz
  • Upload date:
  • Size: 17.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hspfbintoolbox-9.0.7.tar.gz
Algorithm Hash digest
SHA256 a0be6fa80f822e258091e7a6847efc3d8ca4667a08c5167f8547e8f17f106f7e
MD5 e27daf4cf997046427aaeab917df3ebc
BLAKE2b-256 56905459afdea8010afe7798c44dcb427e1f6e23cf998752fce3b8ede8866115

See more details on using hashes here.

Provenance

The following attestation bundles were made for hspfbintoolbox-9.0.7.tar.gz:

Publisher: pypi-package.yml on timcera/hspfbintoolbox

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hspfbintoolbox-9.0.7-py3-none-any.whl.

File metadata

  • Download URL: hspfbintoolbox-9.0.7-py3-none-any.whl
  • Upload date:
  • Size: 63.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hspfbintoolbox-9.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 07ac68522274f5eee2641318928947e2ee005f211b2c9b182e4af6f534ef2a72
MD5 bd4a9b93d85d5ce2c21959e2f0eb40e6
BLAKE2b-256 56a4a7f8eda6252050435bc67c529e24745de1875acbfdf63f6764551064ef74

See more details on using hashes here.

Provenance

The following attestation bundles were made for hspfbintoolbox-9.0.7-py3-none-any.whl:

Publisher: pypi-package.yml on timcera/hspfbintoolbox

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page