Skip to main content
Tests Test Coverage Latest release BSD-3 clause license hspf_reader downloads PyPI - Python Version

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.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hspf-reader 2.0.0
File Size Uploaded
hspf_reader-2.0.0.tar.gz 862.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hspf-reader 2.0.0
File Interpreter ABI Platform
hspf_reader-2.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 926.5 kB

Release files / hspf_reader-2.0.0.tar.gz

Download URL hspf_reader-2.0.0.tar.gz
Size 862.9 kB
Tags Source
SHA-256 checksum
How to use checksums
1b03f3a24028335935776ccf0a2787d64318a6b13a1fb14c4ad65b57fa711dba
BLAKE2b-256 checksum
How to use checksums
8089db02bf2ff6cfe5fc79a9c85a9f5248fc4c9314ea3ebdba1d80f07734e0db
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / hspf_reader-2.0.0-py3-none-any.whl

Download URL hspf_reader-2.0.0-py3-none-any.whl
Size 63.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
16d726699d55cd610678d38fe641552819efc4b231b85ff3851732c5c1bd75d6
BLAKE2b-256 checksum
How to use checksums
d8401136915caf1f7a38de446739cf9e5b5e6ba2a311abee78ae2187aea0bcc7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

2.1.3

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

This release

2.0.0 This release

2 release files

1.0.5

1 release file

1.0.4

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

0.1.8

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page