hspfbintoolbox
Command line script and Python package to read time-series from the Hydrological Simulation Program - FORTRAN (HSPF) binary output.
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 8 committers (12.5%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.4%) to scientific vocabulary
Keywords
cli
hydrology
python
simulation
Keywords from Contributors
tide
template-engine
rank
transformation
moon
sun
tidal
tidalcycles
dataset-generation
weather
Last synced: 6 months ago
·
JSON representation
Repository
Command line script and Python package to read time-series from the Hydrological Simulation Program - FORTRAN (HSPF) binary output.
Basic Info
Statistics
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
- Releases: 0
Topics
cli
hydrology
python
simulation
Created about 11 years ago
· Last pushed 6 months ago
Metadata Files
Readme
Changelog
Contributing
License
Authors
README.rst
.. image:: https://github.com/timcera/hspfbintoolbox/actions/workflows/pypi-package.yml/badge.svg
:alt: Tests
:target: https://github.com/timcera/hspfbintoolbox/actions/workflows/pypi-package.yml
:height: 20
.. image:: https://img.shields.io/coveralls/github/timcera/hspfbintoolbox
:alt: Test Coverage
:target: https://coveralls.io/r/timcera/hspfbintoolbox?branch=master
:height: 20
.. image:: https://img.shields.io/pypi/v/hspfbintoolbox.svg
:alt: Latest release
:target: https://pypi.python.org/pypi/hspfbintoolbox/
:height: 20
.. image:: http://img.shields.io/pypi/l/hspfbintoolbox.svg
:alt: BSD-3 clause license
:target: https://pypi.python.org/pypi/hspfbintoolbox/
:height: 20
.. image:: https://img.shields.io/pypi/pyversions/hspfbintoolbox
:alt: PyPI - Python Version
:target: https://pypi.org/project/hspfbintoolbox/
:height: 20
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
~~~
.. code-block:: bash
pip install hspfbintoolbox
conda
~~~~~
.. code-block:: bash
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)
Owner
- Name: Tim Cera
- Login: timcera
- Kind: user
- Website: https://timcera.bitbucket.io/
- Repositories: 69
- Profile: https://github.com/timcera
Florida Professional Engineer working in water resources. I program to support data analysis and model simulations.
GitHub Events
Total
- Delete event: 1
- Issue comment event: 1
- Push event: 7
- Pull request event: 3
- Create event: 1
Last Year
- Delete event: 1
- Issue comment event: 1
- Push event: 7
- Pull request event: 3
- Create event: 1
Committers
Last synced: 6 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Tim Cera | t****m@c****t | 203 |
| dependabot[bot] | 4****]@u****m | 4 |
| DeepSource Bot | b****t@d****o | 2 |
| Sourcery AI | 1 | |
| Tim Cera | t****a@s****m | 1 |
| Timothy Cera | t****a@n****v | 1 |
| sourcery-ai[bot] | 5****]@u****m | 1 |
| thomas jobes | t****s@s****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 8
- Average time to close issues: N/A
- Average time to close pull requests: about 1 month
- Total issue authors: 0
- Total pull request authors: 4
- Average comments per issue: 0
- Average comments per pull request: 1.25
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 7
Past Year
- Issues: 0
- Pull requests: 4
- Average time to close issues: N/A
- Average time to close pull requests: 6 days
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.75
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 4
Top Authors
Issue Authors
Pull Request Authors
- dependabot[bot] (5)
- sourcery-ai[bot] (2)
- timcera (1)
- deepsource-autofix[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (5)
github_actions (2)
Dependencies
setup.py
pypi
- For *
- List *
- cltoolbox *
- http *
- tstoolbox *
.github/workflows/clean-workflow-runs.yml
actions
- dmvict/clean-workflow-runs v1.0.0 composite
.github/workflows/python-package.yml
actions
- actions/checkout v3 composite
- actions/setup-python v4 composite
pyproject.toml
pypi
- cltoolbox > 1.1.0
- pandas *
- pydantic *
- toolbox_utils >= 5.0.0, < 6.0.0
- typing_extensions *