Options

Contains the description of the desired irradiance and weather data parameters to be returned in the GetWeatherDataResultResponse. Required attributes in the request are: WeatherDataSource, StartTime and EndTime (if WeatherDataSource is time-series based), SpatialResolution_Degrees, TimeResolution_Minutes, and OutputFields or SummaryOutputFields.

WeatherDataSource

The specification of the solar model used in generating the irradiance-specific OutputFields.  Available solar models are license-specific.

Possible values: A string value such as SolarAnywhere3_5.

Currently supported options include:

  • SolarAnywhere3_5: SolarAnywhere time-series version 3.5, available time range 1/1/1998 through 90-day forecast.
  • SolarAnywhere3_4: SolarAnywhere time-series version 3.4, available time range 1/1/1998 through 90-day forecast.
  • SolarAnywhere3_3: SolarAnywhere time-series version 3.3, available time range 1/1/1998 through 90-day forecast.
  • SolarAnywhere3_2: SolarAnywhere time-series version 3.2, available time range 1/1/1998 through 90-day forecast.
  • SolarAnywhere2_5: SolarAnywhere time-series version 2.5, available time range 1/1/1998 through 12/31/2016.
  • SolarAnywhereTGY2020: SolarAnywhere typical GHI year, based on version 3.5, eligible years 1998-2020.
  • SolarAnywhereTDY2020: SolarAnywhere typical DNI year, based on version 3.5, eligible years 1998-2020.
  • SolarAnywhereTGY2019: SolarAnywhere typical GHI year, based on version 3.4, eligible years 1998-2019.
  • SolarAnywhereTDY2019: SolarAnywhere typical DNI year, based on version 3.4, eligible years 1998-2019.
  • SolarAnywhereTGY2018: SolarAnywhere typical GHI year, based on version 3.3, eligible years 1998-2018.
  • SolarAnywhereTDY2018: SolarAnywhere typical DNI year, based on version 3.3, eligible years 1998-2018.
  • SolarAnywhereTGY2016: SolarAnywhere typical GHI year, based on version 3.2, eligible years 1998-2016.
  • SolarAnywhereTDY2016: SolarAnywhere typical DNI year, based on version 3.2, eligible years 1998-2016.
  • SolarAnywhereTGY2012: SolarAnywhere typical GHI year, based on version 2.3, eligible years 1998-2012 (NSRDB equivalent).
  • SolarAnywhereTDY2012: SolarAnywhere typical DNI year, based on version 2.3, eligible years 1998-2012 (NSRDB equivalent)
  • SolarAnywhereAverageYear2020: SolarAnywhere average GHI year, based on version 3.5, long-term averages, 1998-2020.
  • SolarAnywhereAverageYear2019: SolarAnywhere average GHI year, based on version 3.4, long-term averages, 1998-2019.
  • SolarAnywhereAverageYear2018: SolarAnywhere average GHI year, based on version 3.3, long-term averages, 1998-2018.
  • SolarAnywhereAverageYear2016: SolarAnywhere average GHI year, based on version 3.2,long-term averages, 1998-2016.
  • SolarAnywherePOE2020: SolarAnywhere GHI year, based on a user specified probability of exceedance (POE) value, generated using version 3.5, eligible years 1998-2020.
  • SolarAnywherePOE2019: SolarAnywhere GHI year, based on a user specified probability of exceedance (POE) value, generated using version 3.4, eligible years 1998-2019.
  • SolarAnywherePOE2018: SolarAnywhere GHI year, based on a user specified probability of exceedance (POE) value, generated using version 3.3, eligible years 1998-2018.
  • SolarAnywherePOE2016: SolarAnywhere GHI year, based on a user specified probability of exceedance (POE) value, generated using version 3.2, eligible years 1998-2016.
  • TMY3: NREL NSRDB typical GHI year, based on revised TMY3, eligible years 1976-2005 or 1991-2005 depending on location. Will return data from the NSRDB station closest to the requested location.

WeatherDataPreference

The specification of the satellite used in generating the irradiance data fields.  Optional.

Possible values: A string such as Auto.

Currently supported option include:

  • Auto – SolarAnywhere selects the satellite source for the client (recommended). Default.
  • USWestSatellite – Satellite source GOES-W imagery for irradiance data. GOES-W centers images at -135.0 degrees longitude and covers Eastern Colorado and Alberta west towards British Columbia and Hawaii.
  • USEastSatellite – Satellite source GOES-E imagery for irradiance data. GOES-E centers images at -75.0 degrees longitude and covers the Eastern U.S., Caribbean and Mexico to Central Colorado.

PerformTimeShifting

The specification of the time-period averaging of the irradiance-specific OutputFields. Optional.

Possible values: Boolean.

  • True (recommended) – time averaging of non-summary response fields synced to hour ending convention. For instance, StartTime =2011-11-11T00:00:00-08:00, EndTime = 2011-11-11T00:01:00-08:00.
  • False – time averaging of non-summary response fields synced to satellite capture time stamp. For instance, GOES-W: StartTime = 2011-11-11T00:00:30-08:00, EndTime = 2011-11-11T00:01:30-08:00.

StartTime

The specification of the absolute start time of the data request. Required for time-series data. Omitted for typical year data.

Possible values: A string value such as 2011-11-11T00:00:00-08:00.

Follows date:time plus GMT offset convention out of ISO_8601, for example: YYYY-MM-DDTHH:MM:SS-XX:YY, where XX:YY reflects the GMT offset (+ or -).

EndTime

The specification of the absolute end time of the data request. Required for time-series data. Omitted for typical year data.

Possible values: A string value such as 2011-11-12T00:00:00-08:00.

Follows date:time plus GMT offset convention out of ISO_8601, for example: YYYY-MM-DDTHH:MM:SS-XX:YY, where XX:YY reflects the GMT offset (+ or -).

SpatialResolution_Degrees

The specification of the desired spatial resolution of the irradiance-specific OutputFields and SummaryOutputFields.

Possible values: A decimal value such as 0.1.

Currently supported values:

  • 0.1 – Corresponds to an irradiance data resolution of approximately 10-kilometers (Standard Resolution).
  • 0.01 – Corresponds to an irradiance data resolution of approximately 1-kilometer (Enhanced and High Resolution).

TimeResolution_Minutes

The specification of the desired time resolution of the OutputFieldsSummaryOutputFields will be computed at monthly, annual and complete time range of request intervals.

Possible values: An integer of value such as 60.

Currently supported values:

  • 60 – hourly averaging (Standard and Enhanced Resolution).
  • 30 – half-hourly averaging (Enhanced Resolution).
  • 15 – 15-minute averaging (Enhanced Resolution).
  • 10 – 10 minute averaging (High Resolution).
  • 5 – 5 minute average (High Resolution).
  • 1 – minute averaging (High Resolution).

See the Resolution page for more information.

OutputFields

The specification of desired output data fields in the WeatherDataResult response. Availability subject to license access.

Possible values: A string value containing one or more values from the list below, such as GlobalHorizontalIrradiance_WattsPerMeterSquared, separated by a comma.

Currently supported values:

  • StartTime – start time of WeatherDataPeriod.
  • EndTime – end time of WeatherDataPeriod.
  • ObservationTime – observation time of the satellite image used in the irradiance-specific output fields.
  • ForecastLeadTime_Minutes – the number of minutes between the start time of the forecast and the time the forecast was generated.
  • GlobalHorizontalIrradiance_WattsPerMeterSquared – the average total irradiance covering a plane horizontal to the surface of the earth over the period of measure specified by TimeResolution_Minutes. Units of W/m2.
  • DirectNormalIrradiance_WattsPerMeterSquared – the average irradiance incident on a surface normal (perpendicular) to the sun over the period of measure specified by TimeResolution_Minutes. Units of W/m2.
  • DiffuseHorizontalIrradiance_WattsPerMeterSquared – the average scattered irradiance covering a plane horizontal to the surface of the earth over the period of measure specified by TimeResolution_Minutes. Units of W/m2.
  • IrradianceObservationType – data tags that specify the model used in calculations, beyond version number. For more information, see file formats.
  • AmbientTemperature_DegreesC – the average ambient temperature at 2-meters above the surface over the period of measure specified by TimeResolution_Minutes. Units of degrees Celsius.
  • AmbientTemperatureObservationType – data tags that specify the model used in calculations, beyond version number. For more information, see file formats.
  • WindSpeed_MetersPerSecond – the average wind speed at 10-meters above the surface over the period of measure specified by TimeResolution_Minutes. Units of meters per second.
  • WindSpeedObservationType – data tags that specify the model used in calculations, beyond version number. For more information, see file formats.
  • ClearSkyDNI_WattsPerMeterSquared – the average total irradiance covering a surface normal to the sun, assuming clear sky conditions, over the period of measure specified by TimeResolution_Minutes. Units of W/m2.
  • ClearSkyGHI_WattsPerMeterSquared – the average total irradiance covering a plane horizontal to the surface of the earth, assuming clear sky conditions, over the period of measure specified by TimeResolution_Minutes. Units of W/m2.
  • RelativeHumidity_Percent – the measurement of moisture content of the air as a ratio of the partial pressure of water to the vapor pressure at ambient temperature. Percentage.
  • *SnowDepth_Meters – the measurement of the height of solid precipitation accumulated on the ground. Only available when requesting the time series or average year weather data sources. Daily totals are down-sampled to the temporal resolution specified by the client. Units of meters.
  • *LiquidPrecipitation_KilogramsPerMeterSquared – a measurement of volume of liquid, primarily water, that condenses out of the atmosphere. Only available when requesting the time series or average year weather data sources. Units of kg/m2.
  • *SolidPrecipitation_KilogramsPerMeterSquared – a measurement of volume of solid, primarily water, that condenses out of the atmosphere. Only available when requesting the time series or average year weather data sources. Units of kg/m2.
  • SolarZenithAngle_Degrees – the angle between a line that is normal to a horizontal surface on the earth and a line drawn directly to the same horizontal surface from the sun. Units of degrees.
  • SolarAzimuthAngle_Degrees – the direction from which sunlight is reaching a horizontal surface on the earth where north equals 0°, east equals 90°, south equals 180° and west equals 270°. Units of degrees.
  • *Albedo_Unitless – a measurement of the fraction of the GHI that is reflected off the ground. Only available in requests for SolarAnywhere versions 3.5 and later. Unitless.
  • *ParticulateMatter2.5_MicrogramsPerMeterCubed – a measurement of the amount of particles in the air with diameters less than or equal to 2.5 micrometers. Only available in requests for SolarAnywhere versions 3.5 and later for historical data periods (historical time series, typical year, average year, and probability of exceedance data requests). Units of kg/m3.
  • *ParticulateMatter10_MicrogramsPerMeterCubed – a measurement of the amount of particles in the air with diameters less than or equal to 10 micrometers. Only available in requests for SolarAnywhere versions 3.5 and later for historical data periods (historical time series, typical year, average year, and probability of exceedance data requests). Units of kg/m3.

* Not available for forecasted time periods.
 
For more information, see Terms & Concepts.

SummaryOutputFields

The specification of the desired summed insolation fields. Summaries returned in partial or complete monthly, annual and full period of requested insolation.

Possible values: A string of value such as TotalGlobalHortizontalIrradiance.

Currently supported values:

  • TotalGlobalHorizontalIrradiance – total insolation (summed to calendar month and year) on a plane horizontal to the surface of the earth over the period of measure specified by the request StartTime and EndTime. Units of Wh/m2.
  • TotalDirectNormalIrradiance – total insolation (summed to calendar month and year) on a plane normal to the sun over the period of measure specified by the request StartTime and EndTime. Units of Wh/m2.
  • *TotalLiquidPrecipitation – total liquid precipitation (summed to calendar month and year) over the period of measure specified by the request StartTime and EndTime. Data is only available when requesting the time series or average year weather data sources. Units of kg/m2.
  • *TotalSolidPrecipitation – total solid precipitation (summed to calendar month and year)over the period of measure specified by the request StartTime and EndTime. Data is only available when requesting the time series or average year weather data sources. Units of kg/m2.
  • *AverageSnowDepth – Mean height of solid precipitation (averaged to calendar month and year) accumulated on the ground over the period of measure specified by the request StartTime and EndTime. Data is only available when requesting the time series or average year weather data sources.. Units of meters.
  • AverageWindSpeed – Mean wind speed (averaged to calendar month and year) at 10-meters above the surface, over the period of measure specified by the request StartTime and EndTime. Units of meters per second.
  • *AverageAlbedo – Mean measurement (averaged to calendar month and year) of the fraction of GHI that is reflected off the ground over the period of measure specified by the request StartTime and EndTime. Only available in requests for SolarAnywhere version 3.5 and later. Unitless.
  • *AveragePm2.5 – Mean amount of particulate matter in the air (averaged to calendar month and year) with a diameter less than or equal to 2.5 micrometers, over the period of measure specified by the request StartTime and EndTime. Only available in requests for SolarAnywhere versions 3.5 and later for historical data periods (historical time series, typical year, average year, and probability of exceedance data requests). Units of μg/m3.
  • *AveragePm10 –Mean amount of particulate matter in the air (averaged to calendar month and year) with a diameter less than or equal to 10 micrometers, over the period of measure specified by the request StartTime and EndTime. Only available in requests for SolarAnywhere versions 3.5 and later for historical data periods (historical time series, typical year, average year, and probability of exceedance data requests). Units of μg/m3.

* Not available for forecasted time periods.

MissingDataHandling

The specification for handling periods with missing solar model inputs. Missing inputs occur on rare occasions, typically when the satellite images used to predict irradiance are not available. For observations missing four consecutive hours of satellite imagery or less on either side of the timestamp, data are interpolated or extrapolated automatically. Preferences for MissingDataHandling can be specified for observations missing more than four consecutive hours of imagery on either side. To see how the missing data periods were handled include IrradianceObservationType as an OutputField and reference the file formats page on the SolarAnywhere website.

Possible values: A string of value such as FillAverage.

Currently supported values:

  • Omit – missing periods are left blank (default if option is not specified).
  • FillAverage – missing periods are filled with long-term averages. For example, if 2013-02-01T10:00:00-08:00 were a missing observation, the average value for 10:00:00-08:00 on February 1 from all populated years beginning in 1998 would be filled.

ProbabilityOfExceedance

The user specification of the probability value to be used when requesting one of the SolarAnywherePOE weather data sources. The POE weather data sources will return 8760 hourly values composed of actual months of data from the full available time series. To select the actual months of data that will be returned, the first step is to generate a probability distribution based on the full available time series using the partial year method. The second step is to determine the combination of the months of data with the summed GHI closest to the total GHI value from the probability distribution at the level specified by the user.

Possible values: An integer value such as 90.

Currently supported values: 1- 99.