wrfhydropy
Provides an end-to-end python interface to support reproducible research and construction of workflows involving the WRF-Hydro model.
https://github.com/NCAR/wrf_hydro_py
Category: Hydrosphere
Sub Category: Ocean Models
Keywords from Contributors
hydrology earth-science hydrologic-modeling wrf-hydro archiving measur transforms generic conversion optimize
Last synced: about 1 hour ago
JSON representation
Repository metadata
Python API for the WRF-Hydro model
- Host: GitHub
- URL: https://github.com/NCAR/wrf_hydro_py
- Owner: NCAR
- Created: 2018-03-12T14:41:50.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-02-16T21:20:40.000Z (about 1 year ago)
- Last Synced: 2025-04-20T11:03:03.855Z (7 days ago)
- Language: Python
- Size: 11.7 MB
- Stars: 60
- Watchers: 10
- Forks: 43
- Open Issues: 32
- Releases: 10
-
Metadata Files:
- Readme: README.md
README.md
WRF-HYDRO-PY
IMPORTANT: This package is in the very early stages of development and the package API may change at any time. It is not recommended that this package be used for significant work until version 0.1
Description
wrfhydropy provides an end-to-end python interface to support reproducible research and construction of workflows involving the
WRF-Hydro model. See the docs for an extended description of what-and-why wrfhydropy.
Documentation
Documentation is available on-line through help() and via readthedocs. Documentation is a work in progress, please feel free to help improve the documentation or to make an issue when the docs are inaccurate!
Contributing standards
Failure to adhere to contributing standards may result in your Pull Request being rejected.
pep8speaks
All pull requests will be linted automatically by pep8speaks and reported as a comment into the pull request. The pep8speaks configuration is specified in .pep8speaks.yml. All pull requests must satisfy pep8speaks.
Local linting can be performed after a pip install of pycodestyle. Pep8speaks linting reports also update with updated pull requests.
Additional Style Guidelines
- Max line length: 100 chars.
- docstrings: Google style
- All other guidance follows Google style guide
- General advice: Hitchhiker's guide to code style
Testing
All pull requests must pass automated testing (via TravisCI). Testing can be performed locally by running pytest in the wrfhydropy/tests directory. Currently, this testing relies on the nccp binary for comparing netcdf files. A docker container can be supplied for testing on request (and documentation will subsequently be placed here).
Coverage
Testing concludes by submitting a request to coveralls. This will automatically report changes of code coverage by the testing. Coverage should be maximized with every pull request. That is all new functions or classes must be accompanied by comprehensive additional unit/integration tests in the wrf_hydro_py/wrfhydropy/tests directory. Running coverage locally can be achieved by pip installing coverage and pytest-cov following a process similar to the following:
cd wrfhydropy/tests/
pytest --cov=wrfhydropy
coverage html -d coverage_html
chrome coverage_html/index.html # or your browser of choice
Owner metadata
- Name: NSF National Center for Atmospheric Research
- Login: NCAR
- Email:
- Kind: organization
- Description: NSF NCAR is sponsored by the U.S. National Science Foundation and managed by the University Corporation for Atmospheric Research.
- Website: http://ncar.ucar.edu
- Location: Boulder, CO
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/2007542?v=4
- Repositories: 934
- Last ynced at: 2024-04-16T05:55:57.342Z
- Profile URL: https://github.com/NCAR
GitHub Events
Total
- Watch event: 2
Last Year
- Watch event: 2
Committers metadata
Last synced: 6 days ago
Total Commits: 738
Total Committers: 7
Avg Commits per committer: 105.429
Development Distribution Score (DDS): 0.509
Commits in past year: 22
Committers in past year: 3
Avg Commits per committer in past year: 7.333
Development Distribution Score (DDS) in past year: 0.409
| Name | Commits | |
|---|---|---|
| jmills-ncar | j****s@u****u | 362 |
| James McCreight | j****c@u****u | 332 |
| James L McCreight | m****h@g****m | 22 |
| Ryan Cabell | r****l@u****u | 10 |
| Soren Rasmussen | s****n@g****m | 8 |
| Katelyn FitzGerald | k****w@u****u | 2 |
| dependabot[bot] | 4****] | 2 |
Committer domains:
- ucar.edu: 4
Issue and Pull Request metadata
Last synced: 1 day ago
Total issues: 45
Total pull requests: 203
Average time to close issues: 3 months
Average time to close pull requests: 17 days
Total issue authors: 6
Total pull request authors: 7
Average comments per issue: 0.87
Average comments per pull request: 0.9
Merged pull request: 183
Bot issues: 0
Bot pull requests: 4
Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- jmccreight (28)
- tjmills (12)
- rcabell (2)
- kafitzgerald (1)
- scrasmussen (1)
- arezoorn (1)
Top Pull Request Authors
- tjmills (98)
- jmccreight (89)
- scrasmussen (7)
- dependabot[bot] (4)
- ishita9 (2)
- kafitzgerald (2)
- rcabell (1)
Top Issue Labels
- enhancement (6)
- bug (4)
- documentation (2)
- testing (2)
- Portability (1)
Top Pull Request Labels
- dependencies (4)
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 967 last-month
- Total docker downloads: 48
- Total dependent packages: 0
- Total dependent repositories: 8
- Total versions: 49
- Total maintainers: 3
pypi.org: wrfhydropy
API for the WRF-Hydro model
- Homepage: https://github.com/NCAR/wrf_hydro_py
- Documentation: https://wrfhydropy.readthedocs.io/
- Licenses: MIT
- Latest release: 0.0.21 (published about 1 year ago)
- Last Synced: 2025-04-26T14:03:03.758Z (1 day ago)
- Versions: 49
- Dependent Packages: 0
- Dependent Repositories: 8
- Downloads: 967 Last month
- Docker Downloads: 48
-
Rankings:
- Docker downloads count: 3.05%
- Dependent repos count: 5.255%
- Forks count: 6.144%
- Dependent packages count: 7.31%
- Stargazers count: 9.006%
- Average: 9.964%
- Downloads: 29.02%
- Maintainers (3)
Dependencies
- ipython *
- nbsphinx *
- numpydoc *
- boltons >=20.2.1
- bs4 >=0.0.1
- dask >=2.14.0
- deepdiff ==3.3.0
- f90nml >=1.2
- netCDF4 >=1.5.3
- numpy ==1.18.1
- pandas >=1.0.3
- pathlib ==1.0.1
- properscoring ==0.1
- pytest >=5.4.1
- pytest-datadir-ng >=1.1.1
- pytest-html >=3.0.0
- pytest-lazy-fixture >=0.6.3
- requests >=2.23.0
- spotpy >=1.5.14
- xarray ==0.14.1
- boltons >=20.2.1
- bs4 >=0.0.1
- dask *
- actions/checkout v3 composite
- actions/setup-python v4 composite
- mamba-org/setup-micromamba v1 composite
Score: 13.404041461938403