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
wrfhydropy is a Python API for the WRF-Hydro modelling system. The goal of this project is to provide a clean, feature-rich, and unified API for interacting with the many components of the WRF-Hydro modelling system. An descriptive overview of the package is found here.
Documentation is only available on-line through help() and in the source code. Documentation will be forthcoming once the API becomes more stable. Please feel free to help improve the documentation!
Failure to adhere to contributing standards may result in your Pull Request being rejected.
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.
- Max line length: 100 chars.
- docstrings: Google style
- All other guidance follows Google style guide
- General advice: Hitchhiker's guide to code style
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).
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