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

Meteorology - Solarcalculator

This page contains detailed information for the meteorology solarcalculator component.

On this page:

Description

The NOAA Solar Calculator will calculate solar data for a day or a year at a specific location between the year 1901 and 2099. Equation of time, Solar Declination, Apparent Sunrise and Sunset, Solar Noon, and Azimuth are calculated along with several other solar data parameters. Daylight Saving Time is not incorporated in this model. The table below shows respective time zones.

Time Zone Offset

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 solarcalculator input object
ParameterDataTypeDescriptionComments
ModelDrop-down listType of model to run for the solar calculatorYear: returns a value for each day in that year, Day: returns a value for each hour of the day.
Location OptionDrop-down listLocation of interest options.Valid options: Latitude/Longitude, Catchment Centroid. Output time-series is returned for the latitude/longitude at the centroid of the NHDPlusV2.1 catchment when 'catchment (COMID)' is selected.
LatitudeNumberLatitude coordinate for the output timeseries. e.g., 33.925575Used only when 'Latitude/Longitude' is selected for 'Location Option'.
LongitudeNumberLongitude coordinate for the output timeseries. e.g., -83.356893Used only when 'Latitude/Longitude' is selected for 'Location Option'.
Catchment COMIDStringNHDPlusV2.1 catchment COMID.Used only when 'catchment Centroid' is selected for 'Location Option'.
TimezoneStringTimezone of the locationValid timezone value [-12, +14]
Local TimeStringTime for the calculation at the area of interestOnly used with the Year model. Valid format is HH:mm:SS for hour:minutes:seconds
YearStringYear for the calculationValid 4 digit year value.

Output Data Format Options
Format SpecifierNameExample
"E" or "e"Exponential (Scientific).
Exponential notation.
"E": 1052.0329112756 -> 1.052033E+003
"e": 1052.0329112756 -> 1.052033e+003
"E2": -1052.0329112756 -> -1.05E+003
"e2": -1052.0329112756 -> -1.05e+003
"F"Fixed-point.
Integral and decimal digits with optional negative sign.
"F": 1234.567 -> 1234.57
"F1": 1234 -> 1234.0
"F4": -1234.56 -> -1234.5600
"G"General.
The more compact of either fixed-point or scientific notation.
"G": -123.456 -> -123.456
"G4": 123.4546 -> 123.5
"G": -1.234567890e-25 -> -1.23456789E-25
"N"Number.
Integral and decimal digits, group separators, and a decimal separator with optional negative sign.
"N": 1234.567 -> 1, 234.57
"N1": 1234 -> 1, 234.0
"N3": -1234.56 -> -1, 234.560
"R"Round-trip.
A string that can round-trip to an identical number.
"R": 123456789.12345678 -> 123456789.12345678
"R": -1234567890.12345678 -> -1234567890.1234567

Output Parameters

Attributes of the HMS solarcalculator 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/meteorology/humidity/

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