Skip to content

Commit

Permalink
a little report card cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@jtgilbert
jtgilbert committed Oct 31, 2022
1 parent 4baa434 commit b8e23cc
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/About/Status/Tool_ReportCard_0-1-00.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ weight: 1
| Tool | [Riverscape Inundation Mapper (RIM) Tool](https://rim.riverscapes.net) |
| Version | [0.1.00](https://github.com/Riverscapes/RIM/releases/tag/v0.1.0) |
| Date of Review | 2022, October |
| Assessment Team | Names and/or Links |
| Assessment Team | Wheaton & Gilbert |
| Current Assessment | ![research](https://raw.githubusercontent.com/Riverscapes/riverscapes-website/master/assets/images/tools/grade/TRL_3_32p.png) [Research Grade](https://riverscapes.net/Tools/discrimination.html#tool-grade) |
| Target Status | ![research](https://raw.githubusercontent.com/Riverscapes/riverscapes-website/master/assets/images/tools/grade/TRL_3_32p.png) [Research Grade](https://riverscapes.net/Tools/discrimination.html#tool-grade) → No further development as its own tool, Getting subsumed into ![professional](https://raw.githubusercontent.com/Riverscapes/riverscapes-website/master/assets/images/tools/grade/TRL_5_32p.png) [Professional Grade](https://riverscapes.net/Tools/discrimination.html#professional-grade) [QRiS](https://qris.riverscapes.net)|
| Riverscapes Compliance | ![Riverscapes Compliant](https://riverscapes.net/assets/images/rc/RiverscapesCompliantPending_28.png) [Pending Riverscapes Compliance](https://riverscapes.net/Tools/#riverscapes-compliant-tools) - Because it is Research Grade |
| Assessment Rationale | The RIM Tool 0.1.0 is very deserving of both a [Research Grade](https://riverscapes.net/Tools/discrimination.html#tool-grade)) distinction and [Pending Riverscapes Compliance](https://riverscapes.net/Tools/#riverscapes-compliant-tools). It is a perfect example of where we hope researchers and graduate students can get a tool (without too much extra work), so that at least the outputs of the tool can be **F**-**A**-**I**-**R** even if the tool itself is only likely to be reused by a small number. Refactoring this tool into its own Professional Grade tool (or as planned, as part of [QRiS](https://qris.riverscapes.net)) is straight forward, but also beyond the scope of a Masters or most PhDs (requires professional software development help). Though the tool is not *ready* to be used by large audiences, the protocol it lays out is, and the [riverscape project datasets](https://rim.riverscapes.net/Examples/ExampleData.html) it packages are highly consumable. |
| Assessment Rationale | The RIM Tool 0.1.0 is very deserving of both a [Research Grade](https://riverscapes.net/Tools/discrimination.html#tool-grade) distinction and [Pending Riverscapes Compliance](https://riverscapes.net/Tools/#riverscapes-compliant-tools). It is a perfect example of where we hope researchers and graduate students can get a tool (without too much extra work), so that at least the outputs of the tool can be [**F**-**A**-**I**-**R**](https://rim.riverscapes.net/About/Status/Tool_ReportCard_0-1-00.html#f-a-i-r-assessment) even if the tool itself is only likely to be reused by a small number. Refactoring this tool into its own Professional Grade tool (or as planned, as part of [QRiS](https://qris.riverscapes.net)) is straight forward, but also beyond the scope of a Masters or most PhDs (requires professional software development help). Though the tool is not *ready* to be used by large audiences, the protocol it lays out is, and the [riverscape project datasets](https://rim.riverscapes.net/Examples/ExampleData.html) it packages are highly consumable. |



Expand All @@ -34,12 +34,12 @@ Fully Developed: <i class="fa fa-battery-full" aria-hidden="true"></i>
| :----------------------------- | :----------------------------- | | :----------------------------- |
| [Tool Interface(s)]({{ site.baseurl }}/Tools/discrimination.html#interface) | <i class="fa fa-terminal" aria-hidden="true"></i> ArcPy Python Scripts | <i class="fa fa-battery-half" aria-hidden="true"></i> | While the ArcPy scripts are functional, they are also fragile (typical of code with ArcPy dependencies). |
| Scale | Reach (cell scale resolution, reach scale extent) | <i class="fa fa-battery-full" aria-hidden="true"></i> | This toolbox really creates empty feature classes with consistent attributes and naming, to allow the user to digitize riverscape inundation patterns and features at the reach-scale. The user chooses the basemaps (and therefore resolution of imagery), and can decide how detailed to digitize the features. |
| Language(s) and Dependencies | dependencies | <i class="fa fa-battery-half" aria-hidden="true"></i> | Comments. |
| Language(s) and Dependencies | dependencies | <i class="fa fa-battery-half" aria-hidden="true"></i> | The python scripts have ArcPy dependencies (ESRI). |
| Vetted in Peer-Reviewed Literature | Pending review in ESPL. Vetted as Masters Thesis: Bartelt [2021](https://doi.org/10.26076/a66b-0708) | <i class="fa fa-battery-three-quarters" aria-hidden="true"></i> | Awaiting peer review of manuscript. Thesis: - Bartelt K. 2021. Valley Bottom Inundation Patterns in Beaver-Modified Streams: A Potential Proxy for Hydrologic Inefficiency, Masters Thesis, Utah State University: Logan, UT. Available from: [https://digitalcommons.usu.edu/etd/8226](https://digitalcommons.usu.edu/etd/8226). DOI: [10.26076/a66b-0708](https://doi.org/10.26076/a66b-0708). |
| Source Code Documentation | Some comments in source code, and some troubleshooting clear from commit history. | <i class="fa fa-battery-quarter" aria-hidden="true"></i> | Missing ReadMe file. Also, no documentation on specific Python and ArcPy dependencies. |
| Open Source | [Open Source](https://github.com/Riverscapes/RIM) <i class="fa fa-github" aria-hidden="true"></i> with [GNU General Public License v 3.0](https://github.com/Riverscapes/gcd/blob/master/LICENSE) | <i class="fa fa-battery-full" aria-hidden="true"></i> | Follows Riverscape Compliance standards (see [issue #1](https://github.com/Riverscapes/RIM/issues/1). |
| Open Source | [Open Source](https://github.com/Riverscapes/RIM) <i class="fa fa-github" aria-hidden="true"></i> with [GNU General Public License v 3.0](https://github.com/Riverscapes/gcd/blob/master/LICENSE) | <i class="fa fa-battery-full" aria-hidden="true"></i> | Follows Riverscape Compliance standards (see [issue #1](https://github.com/Riverscapes/RIM/issues/1)). |
| Tool and Source Code Citable | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7265508.svg)](https://doi.org/10.5281/zenodo.7265508) | <i class="fa fa-battery-full" aria-hidden="true"></i> | Karen Barelt, Joe Wheaton, Matt Reimer, Margaret Hallerud, Philip Bailey, & Jordan Gilbert. (2022). Riverscapes Inundation Mapper - RIM 0.1 (v0.1.0). Zenodo. [https://doi.org/10.5281/zenodo.7265508](https://doi.org/10.5281/zenodo.7265508]) |
| User Documentation | Basic documentation on [Running the RIM Tool]({{ sitebase.url }}/Documentation/running/) and a [Protocol]({{ site.baseurl}}/Documentation/Protocols/). For users looking to visualize [outputs]({{ site.baseurl }}/Examples/ExampleData), there are a [few videos]({{ site.baseurl }}/Documentation/Viewing.html)). | <i class="fa fa-battery-quarter" aria-hidden="true"></i> | There is basic, minimal documentation that complies with the [Tool Website Documentation Standards](https://riverscapes.net/Tools/Technical_Reference/Documentation_Standards/WebSites/). However, the help could be elaborated and improved with some video tutorials. |
| User Documentation | Basic documentation on [Running the RIM Tool]({{ sitebase.url }}/Documentation/running/) and a [Protocol]({{ site.baseurl}}/Documentation/Protocols/). For users looking to visualize [outputs]({{ site.baseurl }}/Examples/ExampleData), there are a [few videos]({{ site.baseurl }}/Documentation/Viewing.html). | <i class="fa fa-battery-quarter" aria-hidden="true"></i> | There is basic, minimal documentation that complies with the [Tool Website Documentation Standards](https://riverscapes.net/Tools/Technical_Reference/Documentation_Standards/WebSites/). However, the help could be elaborated and improved with some video tutorials. |
| Easy User Interface | Basic ArcPy scripts with no help. | <i class="fa fa-battery-quarter" aria-hidden="true"></i> | These are really basic research scripts. Those familiar with ArcPy from command prompt in ArcGIS 10.X will find the [workflows]({{ sitebase.url }}/Documentation/running/) familiar. |
| Scalability | The scripts have ArcPy depencencies and since ArcGIS 10.x is a 32-Bit software, memory problems are possible (i.e. 4GB RAM). However, since the tool is primarily intended to be used on reach-scale, hand digitized riverscape data, these issues are probably not realized. | <i class="fa fa-battery-quarter" aria-hidden="true"></i> | There is nothing complicated in this that couldn't easily be reafactored to opensource GIS and written to handle larger datasets. The project sizes are bloated primarily because of the UAV rasters (typically 2.5 to 7 cm resolution and often > 1 GB each). There is also a lot of storage in the contextual layers (e.g. DEM), which span an entire watershed. Watershed Attribute Tool and other projects in QRiS could keep the actual data here (i.e. digitized layers) much more compact and separate out the bases into their own projects. |
| Produces [Riverscapes Projects]({{ site.baseurl }}/Tools/Technical_Reference/Documentation_Standards/Riverscapes_Projects/) <img src="https://riverscapes.net/assets/images/data/RiverscapesProject_24.png"> | Tool is outputting to disk data in a Riverscapes Project that can be opened in [RV](http://rave.riverscapes.net). | <i class="fa fa-battery-three-quarters" aria-hidden="true"></i> | The business logic and symbology has been nicely curated and works well in QRV and ArcRV. However, the rasters still do not display nicely in WebRAVE (see [issue #14](https://github.com/Riverscapes/RIM/issues/14)). |
Expand Down

0 comments on commit b8e23cc

Please sign in to comment.