This report card communicates the compliance of the Riverscapes Context tool for the United States with the Riverscape Consortium's published tool standards.
Report Card Summary
| Tool | Riverscapes Context Tool |
|---|---|
| Version | 1.2.2 |
| Date | 2021-11-22 |
| Assessment Team | Bailey, Wheaton & Gilbert |
| Current Assessment | Production Grade |
| Riverscapes Compliance | Compliant |
| Assessment Rationale | The tool can be used to aggregate data anywhere the nationally available datasets used to drive many riverscapes tools are available, and produces riverscapes projects that are compatible with RAVE. These projects are also being uploaded to the riverscapes warehouse. The tool needs documentation, but qualifies for Production Grade. |
Report Card Details
This tool's discrimination evaluation by the Riverscapes Consortium is:
| Criteria | Value | Evaluation | Comments and/or Recommendations |
|---|---|---|---|
| Tool Interface(s) | CLI | Pass | |
| Scale | Catchment | Pass | This tool is designed to aggregate data at the HUC catchment scale. Most commonly we run this at HUC 8 scale, but HUC 10 and HUC 12 runs have been run. HUC 6 runs are possible but get to be large projects and custom boundaries are possible. |
| Language(s) and Dependencies | Python | Pass | Package dependencies are open source |
| Vetted in Peer-Reviewed Literature | Yes | Pass | Not applicable. The datasets the tool gathers are vetted, nationally available datasets. |
| Source Code Documentation | Github repository | Pass | Source code is clearly organized and documented |
| Open Source | open-source with GNU General Public License v 3.0 | Pass | |
| User Documentation | Documentation is in progress | Partial | Documentation is in progress but has not been published to the website |
| Easy User Interface | Tool is accessed via command prompt | Partial | The tool is primarily run by North Arrow Research analysts. For a user to run this version of the tool themselves would require advanced understanding (programming capability) and significant documentation on the process. A "web-store" was piloted where users could request a HUC 8, 10 or 12 and get a run produced in cloud for them and uploaded to warehouse. That works and is available by request, but will be added to Warehouse 2.0. |
| Scalability | batch-processing | Pass | Tool is typically batch processed at the HUC 8 level. If less layers are included, it can be run at larger scales. |
| Produces Riverscapes Projects | Yes | Pass | Produces Riverscapes Projects that are fully-compatible with Riverscapes Viewer |
Tool Output Utility
| Criteria | Value | Evaluation | Comments |
|---|---|---|---|
| RAVE- Compliant Riverscapes Projects | Yes | Pass | |
| RAVE Business Logic Defined | Yes | Pass | |
| Riverscapes Projects hosted in public-facing Riverscapes Warehouse(s) | Yes. Current Riverscape Context projects are being housed in the Riverscapes Warehouse. | Partial | There is data in the warehouse, but is provisional and wider access to the warehouse is forthcoming |
| Riverscapes Projects connected to Web-Maps | Yes | Pass | Current projects are viewable in the Riverscapes Data Exchange |
| Riverscapes Projects connected to Field Apps | No | Partial | These can be used as basemaps or context layers with QField. |
Developer Intent
The Riverscapes Context tool was one of the first production grade tools. It has worked extremely well and has now been successfully run on 99% of the 15,000 HUC10 watersheds in the United States and those projects are freely availalbe.
Future enhancements
- Updating RS_Conext to use geopackages instead of shapefiles for some of the vector feature classes it "wraps up". The tool has tended not to change from the parent format of vectors (typically awful shapefiles with all their sidecar files), but it does change rasters into GeoTIFFs. There are many advantages to geopackages over shapefiles for vector data. If this is done, it will likely be with one geopackage for each data type source (e.g. one for NHD and one for Land Ownership).
- Continue to add new layers that are useful to users for context or as inputs to other production grade models. A running list is here
- Expand functionality so it can work for any user provided custom polygon extent (provided that underlyng context datasets exist for that area)
- Expand functionality to other countries (initially those that have consistent, good cartographic standards) and eventually to global datasets.