Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dblodgett-usgs committed Sep 5, 2024
1 parent 2d4d7c8 commit 7a8c966
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

## Tools for Manipulating the NHDPlus Network in Preparation for Hydrologic Modeling

The hyRefactor package was developed over a considerable period of time as part of a broad research project to develop a unified hydrofabric for the U.S. Geological Survey National Water Census and National Weather Service National Water Model. Work on this specific package has moved to a new development space under https://github.com/noaa-owp/hydrofab. That package will be released as a USGS data release when ready.

Software in this package has been rigorously tested (90% code coverage shown in [v0.4.8_coverage.html](v0.4.8_coverage.html)) and results of its use have been evaluated extensively. Any use outside of the National Hydrologic Geospatial Fabric workflow it was developed for may produce unexpected results.

Documentation in the package was developed as a best effort by the authors while the package was in development. Some exported functions may have limited documentation in which case package code should be inspected to understand nuances of the implementation.
The purpose of this software release is to document a version of a methodology and associated implementing software used to create a separate Data Release (https://www.sciencebase.gov/catalog/item/60be0e53d34e86b93891012b). This software was used to make derivatives of the features in the NHDPlus geospatial dataset for use in hydrologic model applications. It is not intended for users to deploy/use and may produce unexpected results outside the workflow and environment in which it was implemented. For users seeking to deploy a version of this software, please see https://github.com/noaa-owp/hydrofab.

### Installation:

Expand Down

0 comments on commit 7a8c966

Please sign in to comment.