Workflow - Time of travel
This page contains detailed information for the time of travel component.
On this page:
Description
This workflow calculates the time of travel for a contaminant through a network of streams based on the velocity and flow through the network. The workflow requires the user to select which stream segments the network starts and ends on. Because this workflow is a forecast tool, the time span for the workflow consists of an 18 hour time span starting from the current local time. The connected stream network is automatically generated based on the input streams, and flow data for the network can either be provided by the user or retrieved from the National Water Model data source. The resulting time series of data can be downloaded as a CSV or JSON, either per catchment or as one combined time series.
Input Parameters
Attributes of the HMS Time Of Travel input object
| Parameter | DataType | Description | Comments |
|---|---|---|---|
| Start COMID | Number | COMID for the starting NHD stream catchment. | Output time-series is returned for each catchment in the connected network between the two selected NHDPlusV2.1 catchments. |
| End COMID | Number | COMID for the ending NHD stream catchment. | |
| Source of Streamflow Data | Drop-down list | Streamflow data source | Valid sources: National Water Model, Input Table |
| Contaminant Inflow | Number | Amount of contaminant inflow present at the given timestep in cubic meters per second. | Used only when 'Input Table' is selected for 'Source of Streamflow Data'. |
Output Parameters
Attributes of the HMS Time Of Travel output object
| Column | DataType | Description |
|---|---|---|
| dataset | String | Primary dataset of the requested timeseries. Some API calls return more than one dataset, either for a workflow API or other relevent dataset. |
| dataSource | String | Primary source of the requested timeseries. |
| metaData | Dictionary | Metadata for the output timeseries, includes metadata from the source as well as HMS metadata. |
| data | Dictionary | Output timeseries data is returned as a dictionary, where the key is the datetime stamp and value is a list of values for the source/dataset. |
Web Service Details
Swagger UI
HTTP API
| Method | URL |
|---|---|
| POST | https://qed.epa.gov/hms/rest/api/v3/workflow/timeoftravel/ |
Change Log
Version: 0.1 Beta : May 29, 2019
- Production UI and documentation initial setup.