pvlib.iotools.get_solcast_tmy#

pvlib.iotools.get_solcast_tmy(latitude, longitude, api_key, map_variables=True, **kwargs)[source]#

Get irradiance and weather for a Typical Meteorological Year (TMY) at a requested location.

Data is derived from a multi-year time series selected to present the unique weather phenomena with annual averages that are consistent with long term averages. See 1 for details on the calculation.

Parameters

latitude (float) – in decimal degrees, between -90 and 90, north is positive
longitude (float) – in decimal degrees, between -180 and 180, east is positive
api_key (str) – To access Solcast data you will need an API key 2.
map_variables (bool, default: True) – When true, renames columns of the DataFrame to pvlib variable names where applicable. See variable VARIABLE_MAP. Time is the index shifted to the midpoint of each interval from Solcast’s “period end” convention.
kwargs – Optional parameters passed to the API. See 3 for full list of parameters.

Returns

data (pandas.DataFrame) – containing the values for the parameters requested. The times in the DataFrame index indicate the midpoint of each interval.
metadata (dict) – latitude and longitude of the request.

Examples

>>> df, meta = pvlib.iotools.solcast.get_solcast_tmy(
>>>      latitude=-33.856784,
>>>      longitude=151.215297,
>>>      api_key="your-key"
>>> )

you can pass any of the parameters listed in the API docs, like time_zone. Here we set the value of 10 for “10 hours ahead of UTC”:

>>> df, meta = pvlib.iotools.solcast.get_solcast_tmy(
>>>     latitude=-33.856784,
>>>     longitude=151.215297,
>>>     time_zone=10,
>>>     api_key="your-key"
>>> )

References

1: Solcast TMY Docs
2: Get an API Key
3: Solcast API Docs