An official website of the United States government.

We've made some changes to EPA.gov. If the information you are looking for is not here, you may be able to find it on the EPA Web Archive or the January 19, 2017 Web Snapshot.

HMS: Hydrologic Micro Services

Workflow - Precip data extraction

This page contains detailed information for the precipitation data extraction component.

On this page:

Description

This workflow automatically extracts precipitation data from four national sources and compiles data into a consistent format. The workflow requires the user to select an NCEI station. Data from the user selected NCEI Station along with data from three gridded data sources (NLDAS, GLDAS, and TRMM) at the same location and time frame are downloaded and reformatted. It should be noted that dates in time-series refer to local time-zone. The algorithm converts time-series from GMT to local time-zone for NLDAS, GLDAS, and TRMM. A uniform distribution of values is assumed within a time step for gridded data sources when converting to local time zone. A temporal resolution of daily or monthly can be chosen for data requests. Summary statistics are provided for each of the four data sources. The time series of data downloaded for the time period and location can be downloaded as a CSV or JSON.

Capabilities

Version - 0.1

  1. Capability 1.
  2. Capability 2.
  3. Capability 3.
  4. Capability 4.
  5. Capability 5.

Input Parameters

Attributes of the HMS Precipitation Data Extraction input object
ParameterDataTypeDescriptionComments
NCEI Station IDStringNOAA NCEI station identification number e.g. GHCND:USW00013874Station identifiers can be obtained from NOAA’s tool at https://www.ncdc.noaa.gov/cdo-web/datatools/findstation
Start DateStringStart date for the output timeseries. e.g., 01/01/2010
Data Availability

nldas: hourly 1/1/1979 – Present (~4-day lag); North America @ 0.125 deg resolution.
gldas: 3-hourly 1/1/2000-Present (~1-month lag); Global @ 0.250 deg resolution.
ncei: depends upon selected station
trmm: daily 12/31/1997-11/30/2019; Global 50 deg South and 50 deg North latitudes @.250 deg resolution.
End DateStringEnd date for the output timeseries. e.g., 01/01/2010
Temporal ResolutionDrop-down listTemporal resolution/timestep of the output time-series.Valid options: daily, monthly.

Output Parameters

Attributes of the HMS Precipitation Data Extraction output object
ColumnDataTypeDescription
datasetStringPrimary dataset of the requested timeseries. Some API calls return more than one dataset, either for a workflow API or other relevent dataset.
dataSourceStringPrimary source of the requested timeseries.
metaDataDictionaryMetadata for the output timeseries, includes metadata from the source as well as HMS metadata.
dataDictionaryOutput 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

MethodURL
POSThttps://qed.epa.gov/hms/rest/api/v3/workflow/precip_data_extraction/

Change Log

Version: 0.1 Beta : May 29, 2019

  1. Production UI and documentation initial setup.

Code Samples

Usage Title 1

Problem Statement: NA 1.

Desired Information: NA 1.

Information Returned from Service: NA 1.

Sample code for accessing API