docs - home page list component improvements

Riverscapes · Jul 26, 2024 · a508f1e · a508f1e
1 parent 9eb9d93
commit a508f1e
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 44 deletions.
diff --git a/docs/content/data/tools.json b/docs/content/data/tools.json
@@ -5,9 +5,9 @@
     "description": "Discovers and compiles together disparate datasets that are helpful for contextualizing riverscape health. ",
     "url": "https://tools.riverscapes.net/rscontext",
     "status": ["Production"],
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
     "extent": ["Network"],
     "language": ["Python"],
@@ -18,10 +18,11 @@
     "name": "Channel Area",
     "description": "The Channel Area Tool is a simple tool for generating polygons representing the spatial extent of the drainage network within a watershed.",
     "url": "https://tools.riverscapes.net/channelarea/",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -30,10 +31,11 @@
     "name": "TauDEM",
     "description": "The Terrain Anlysis Using Digital Elevation Models (TauDEM) is a suite of tools developed by David Tarboton at Utah State University's Hydrology Research Group. The Riverscapes compliant, Production Grade TauDEM, utilizes some of the useful TauDEM algorithms, packaging inputs and outputs into a Riverscapes project that can be accessed as a product of its own, or used as inputs to other Riverscapes tools.",
     "url": "https://tools.riverscapes.net/taudem/",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Cell"]
   },
@@ -42,10 +44,11 @@
     "name": "VBET",
     "description": "The Valley Bottom Extraction Tool (VBET) is a tool used to identify the valley bottom of a riverscape, and roughly separate it into geomorphic units (channel, active floodplain, and inactive floodplain).",
     "url": "https://tools.riverscapes.net/vbet/",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -54,10 +57,11 @@
     "name": "Anthropologic Context",
     "description": "Dervies anthropologic context from a variety of sources.",
     "url": "https://tools.riverscapes.net/anthro/",
-    "purpose": ["Operational"],
+    "grade": ["Operational"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -66,10 +70,11 @@
     "name": "Confinement",
     "description": "Quantifies the amount that reaches are confined by valley margins.",
     "url": "https://tools.riverscapes.net/confinement/",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -78,10 +83,11 @@
     "name": "Riparian Condition Assessment Tool",
     "description": "",
     "url": "https://tools.riverscapes.net/rcat/",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -90,10 +96,11 @@
     "name": "Hydrological Context",
     "description": "A series of algorithms that calculate key discharges for assessing riverscapes health.",
     "url": "https://tools.riverscapes.net/rcat/",
-    "purpose": ["Research"],
+    "grade": ["Research"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -102,10 +109,11 @@
     "name": "Metric Engine",
     "description": "Synthesizes and calculates metrics from a variety of other riverscapes models.",
     "url": "https://tools.riverscapes.net/rme/",
-    "purpose": ["Research"],
+    "grade": ["Research"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -114,10 +122,11 @@
     "name": "BRAT",
     "description": "The Beaver Restoration Assessment Tool (BRAT) is a tool used to assess the potential for beaver restoration in a riverscape.",
     "url": "https://tools.riverscapes.net/brat/",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
-    "interface": ["CLI"],
+    "interface": ["Command Line"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -126,10 +135,11 @@
     "name": "GCD",
     "description": "The Geomorphic Change Detection, GCD, measures differences between elevation rasters while accounting for uncertainty.",
     "url": "https://gcd.riverscapes.net",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
     "interface": ["ArcMap AddIn", "Standalone PC"],
     "resolution": ["Cell"],
+    "extent": ["Any"],
     "language": ["C#"],
     "family" : ["Network Scale Tools"]
   },
@@ -138,10 +148,11 @@
     "name": "Fluvial Corridor Toolbox",
     "description": "",
     "url": "https://github.com/EVS-GIS/Fluvial-Corridor-Toolbox-ArcGIS",
-    "purpose": ["Research"],
+    "grade": ["Research"],
     "compliance": ["Non-Compliant"],
     "interface": ["ArcMap Toolbox"],
     "resolution": ["Reach"],
+    "extent": ["Network"],
     "language": ["Python"],
     "family" : ["Network Scale Tools"]
   },
@@ -150,10 +161,11 @@
     "name": "Geomorphic Unit Toolbox",
     "description": "",
     "url": "https://gut.riverscapes.net/",
-    "purpose": ["Research"],
+    "grade": ["Research"],
     "compliance": ["Non-Compliant"],
     "interface": ["ArcMap Toolbox"],
     "resolution": ["Cell"],
+    "extent": ["Reach"],
     "language": ["Python"],
     "family" : []
   },
@@ -162,10 +174,11 @@
     "name": "Riverscapes Viewer for QGIS",
     "description": "",
     "url": "https://viewer.riverscapes.net",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
     "interface": ["QGIS Plugin"],
     "resolution": ["Any"],
+    "extent": ["Any"],
     "language": ["Python"],
     "family" : []
   },
@@ -174,10 +187,11 @@
     "name": "Riverscapes Viewer for ArcMap",
     "description": "",
     "url": "https://viewer.riverscapes.net",
-    "purpose": ["Professional"],
+    "grade": ["Professional"],
     "compliance": ["Compliant"],
     "interface": ["ArcMap AddIn"],
     "resolution": ["Any"],
+    "extent": ["Any"],
     "language": ["c#"],
     "family" : []
   },
@@ -186,10 +200,11 @@
     "name": "Riverscapes Viewer for ArcPro",
     "description": "",
     "url": "https://viewer.riverscapes.net",
-    "purpose": ["Professional"],
+    "grade": ["Professional"],
     "compliance": ["Compliant"],
     "interface": ["ArcPro AddIn"],
     "resolution": ["Any"],
+    "extent": ["Any"],
     "language": ["c#"],
     "family" : []
   },
@@ -198,10 +213,11 @@
     "name": "Riverscapes Viewer for Web",
     "description": "",
     "url": "https://viewer.riverscapes.net",
-    "purpose": ["Commercial"],
+    "grade": ["Commercial"],
     "compliance": ["Compliant"],
     "interface": ["Web"],
     "resolution": ["Any"],
+    "extent": ["Any"],
     "language": ["nodeJs"],
     "family" : []
   },
@@ -210,10 +226,11 @@
     "name": "Fish Habitat Model",
     "description": "",
     "url": "https://habitat.northarrowresearch.com",
-    "purpose": ["Operational"],
+    "grade": ["Operational"],
     "compliance": ["Non-Compliant"],
     "interface": ["Standalone PC"],
     "resolution": ["Cell"],
+    "extent": ["Reach"],
     "language": ["c#"],
     "family" : []
   },
@@ -222,10 +239,11 @@
     "name": "CHaMP Topo Processing tools",
     "description": "",
     "url": "https://champtopo.northarrowresearch.com",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Non-Compliant"],
     "interface": ["ArcMap AddIn"],
     "resolution": ["Any"],
+    "extent": ["Reach"],
     "language": ["c#"],
     "family" : []
   },
@@ -234,10 +252,11 @@
     "name": "Data Exchange",
     "description": "The Riverscapes Data Exchange is a warehouse for storing, discovering and sharing riverscapes compliant data.",
     "url": "https://data.riverscapes.net",
-    "purpose": ["Production"],
+    "grade": ["Production"],
     "compliance": ["Compliant"],
     "interface": ["Web"],
     "resolution": ["Any"],
+    "extent": ["Any"],
     "language": ["nodeJS"],
     "family" : []
   }

diff --git a/docs/content/page/index.mdx b/docs/content/page/index.mdx
@@ -1,7 +1,7 @@
 ---
 title: Riverscapes Tools
 layout: default
-description: home page for Riverscapes Tools documentation
+description: Home page for riverscapes tools documentation
 banner: true
 isHome: false
 ---
@@ -18,22 +18,24 @@ import RMEImage from '/static/images/tool-tiles/RME_Tile.png'
 
 <Container maxWidth="xl">
 
-# RC Production-Grade, Network-Scale Tools
+Use the list below to discover and learn more about tools related to riverscapes health. Use the filters to find tools that comply with the Riverscapes Consortium's tool standards, and that meet the tool grade that you are looking for.
 
-Welcome to the documentation for the [Riverscape Consortium's](https://riverscapes.net) own production-grade family of network-scale riverscape models. These are riverscapes-compliant tools, which have been refactored to be capable of running in the cloud over regional, state-wide and/or nation-wide extents, while still resolving predictions of what is happening in individual reaches (i.e. 100 m to 500 m length scales) of riverscape.
+Some of the tools are developed by the [Riverscapes Consortium](https://riverscapes.net)'s own developers and these tools also have documentation on this website. Other tools listed below were developed by partners and collaborators.
 
-Unlike some of our operational-grade and professional-grade GIS tools, which "users" run the models themselves in desktop GIS, these tools are run centrally in the cloud and their outputs are consumed by users through the [Riverscapes Viewer](http://viewer.riverscapes.net) in the web browser or through desktop GIS. Users can access tool outputs, which our packaged as riverscapes projects in our [Riverscapes Data Exchange](https://data.riverscapes.net/).
+<Alert severity="success"> The Riverscapes Consortium is committed to supporting the development of tools that meet the consortium's standards, and to providing a platform for the distribution of these tools. Email the Riverscapes Consortium at [email protected] if you have a tool that you would like listed here.</Alert>
+
+Learn more about: [tool grade](https://developer.riverscapes.net/MIGRATED/Tools/toolStandards/) and [riverscapes standards and compliance](https://developer.riverscapes.net/standards/)
 
 <ToolListContainer name="Explore Applications" initialFilters={{
-  purpose: [],
-  compliance: [],
+  grade: ["Production","Professional", "Commercial"],
+  compliance: ["Compliant"],
   interface: [],
   resolution: []
 }} />
 
 # The Waterfall
 
-The tools listed above can be chained together to create a "waterfall" that produces a riverscapes project. The Riverscapes Context tool is the first tool in the waterfall, and it is used to create a series of riverscapes projects focused on different aspects of riverscape health. 
+The Riverscapes Consortium production-grade tools listed above can be chained together to create a "waterfall" that produces a riverscapes project. The [Riverscapes Context](/rscontext) tool is the first tool in the waterfall, and it is used to create a series of riverscapes projects focused on different aspects of riverscape health. 
 
 All models depend on an initial [Riverscapes Context](/rscontext) project that collects together the prerequisite national datasets for a given watershed. The dependencies of the other tools are shown in the waterfall diagram below. The [Riverscapes Metric Engine](/rme) collatates metrics from the other tools to create a comprehensive assessment of riverscape health based on Discreet and Integrated Geographic Objects (DGO and IGO respectively).
 

diff --git a/docs/content/page/viewing-projects.mdx b/docs/content/page/viewing-projects.mdx
@@ -1,5 +1,5 @@
 ---
-title: Viewing Projects
+title: Viewing Data
 description: Instructions for viewing the content of a Riverscapes project.
 banner: true
 layout: default

diff --git a/docs/package.json b/docs/package.json
@@ -6,7 +6,7 @@
   "license": "MIT",
   "author": "Matt Reimer <[email protected]>",
   "dependencies": {
-    "@riverscapes/gatsby-theme": "^0.1.31",
+    "@riverscapes/gatsby-theme": "^0.1.32",
     "gatsby": "^5.13.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

diff --git a/docs/yarn.lock b/docs/yarn.lock
@@ -3242,9 +3242,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@riverscapes/gatsby-theme@npm:^0.1.31":
-  version: 0.1.31
-  resolution: "@riverscapes/gatsby-theme@npm:0.1.31"
+"@riverscapes/gatsby-theme@npm:^0.1.32":
+  version: 0.1.32
+  resolution: "@riverscapes/gatsby-theme@npm:0.1.32"
   dependencies:
     "@emotion/react": "npm:^11.11.0"
     "@emotion/styled": "npm:^11.11.0"
@@ -3273,15 +3273,15 @@ __metadata:
     gatsby: ^5.13.0
     react: ^18.2.0
     react-dom: ^18.2.0
-  checksum: 10c0/694da7ee56a3a974419f31bd91a8d303ec1493f65b5d2c9385b5eb0364df97b22bbfa53d41953d1d28283be3ca6e90fe859ae10416e01480076c0241f599aaab
+  checksum: 10c0/416e1382fc223820c1c0aa2d31f5251797ab2e13c5745a66508b46a551a74607f0d4edf71f8567b15d2df7583ed953238f55def20dd0f52154429510aa3a4265
   languageName: node
   linkType: hard
 
 "@riverscapes/template-clean@workspace:.":
   version: 0.0.0-use.local
   resolution: "@riverscapes/template-clean@workspace:."
   dependencies:
-    "@riverscapes/gatsby-theme": "npm:^0.1.31"
+    "@riverscapes/gatsby-theme": "npm:^0.1.32"
     gatsby: "npm:^5.13.0"
     react: "npm:^18.2.0"
     react-dom: "npm:^18.2.0"