Welcome to the TethysDash Documentation!

TethysDash is a Tethys Platform application that empowers users to create custom dashboards for streamlined data discovery.

With the TethysDash dashboard builder, users can easily add, configure, and arrange a variety of visualizations to display data from multiple sources in a cohesive and interactive way.

TethysDash provides a robust set of built-in visualization plugins and features for building effective dashboards and applications. Its true strength lies in flexibility and extensibility—dashboards can leverage preinstalled plugins to perform custom and complex analyses. For details on the plugin architecture and developing new plugins, see the Visualization Plugins section.

Try the TethysDash demo: http://demo.firo.aquaveo.com/apps/tethysdash/

Example dashboard using multiple visualization plugins to display data from various sources.

For more information about creating and using dashboards, see the Dashboards section.

Note

This project is under active development.

Contents

• Installation and Setup
  • Quick Installation
  • Development Installation
  • Frontend Development
  • Frontend Build
  • Frontend Test
  • Websocket Configuration
• Landing Page
  • Dashboard Cards
  • Creating a Dashboard
  • Dashboard Card Context Menu
  • Importing Dashboards
  • Manage Visualization Permissions
  • Manage Groups
• Dashboards
  • Editing Dashboards
    • Tabs
    • Adding Dashboard Items
    • Dashboard Item Context Menu
  • Configuring Visualizations
    • Visualization Tab
    • Default Visualization Types
    • Settings Tab
  • Dashboard Settings & Saving
    • Dashboard Settings
    • Saving & Reverting Changes
• Variable Inputs
  • Setup
  • Connecting to Visualizations
• Visualization Plugins
  • Development
    • Creating a repository
    • TethysDash Plugin Class
    • Plugin Visualization Types
    • Testing
  • Installation
  • Sending Progress Updates
• Maps
  • Create a Map
    • Base Map
    • Layer Controls
    • Layers
    • Map Extent
    • Map Drawing
  • Configure a Map Layer
    • Layer Tab
    • Source Tab
    • Style Tab
    • Legend Tab
    • Attributes/Table Popup Tab
    • Custom Modal Popup Tab
• Tutorials
  • RFC Max Stage Analysis
    • What you will build
    • Prerequisites
    • Step 1 — Create the dashboard
    • Step 2 — Add the RFC Max Forecast map
    • Step 3 — Create the LID variable input
    • Step 4 — Add the gauge hydrograph
    • Step 5 — Add impact statements
    • Step 6 — Add the streamflow forecast
    • Step 7 — Arrange the layout
    • Try it out
  • GEOGLOWS Demo
    • What you will build
    • Prerequisites
    • Step 1 — Create the dashboard
    • Step 2 — Edit the existing grid item to be a Map
    • Step 3 — Add the map layer
    • Step 4 — Edit the layer source
    • Step 5 — Edit attributes and popup
    • Step 6 — Save the layer
    • Step 7 — Edit the Map Extent
    • Step 8 — Save the map
    • Step 9 — Save the dashboard
    • Step 10 — Update Dashboard Item Placement Restrictions
    • Step 11 — Re-enter edit mode
    • Step 12 — Add a Base Map variable input
    • Step 13 — Edit the map
    • Step 14 — Change the base map to reference the variable input
    • Step 15 — Save the map
    • Step 16 — Save the dashboard
    • Step 17 — Explore
    • Troubleshooting
    • Final Solution
  • GEOGLOWS Demo (Part 2)
    • What you will build
    • Prerequisites
    • Step 1 — Edit the dashboard
    • Step 2 — Edit the map layer
    • Step 3 — Connect comid to a river_id variable input
    • Step 4 — Inspect the GeoGLOWS Forecast Plot plugin
    • Step 5 — Add a new dashboard item
    • Step 6 — Configure the GeoGLOWS Forecast Plot
    • Step 7 — Configure the plot’s settings
    • Step 8 — Save the item
    • Step 9 — Resize and place the plot
    • Step 10 — Save the dashboard
    • Try it out
    • Final Solution
  • Custom Popup Modal (GEOGLOWS Forecast)
    • What you will build
    • Prerequisites
    • Step 1 — Edit the dashboard
    • Step 2 — Edit the map layer
    • Step 3 — (Optional) Alias the comid attribute
    • Step 4 — Inspect the GeoGLOWS Forecast Plot plugin
    • Step 5 — Enable Custom Popup Modal on the layer
    • Step 6 — Add the forecast plot to the popup layout
    • Step 7 — Save the layer and map
    • Step 8 — Save the dashboard
    • Try it out
    • Next steps
• Feedback
  • Visualization Requests
  • Bugs/Issues