solarpy.horizon.get_horizon_mines

solarpy.horizon.get_horizon_mines#

solarpy.horizon.get_horizon_mines(latitude, longitude, altitude=None, ground_offset=0, url='http://toolbox.1.webservice-energy.org/service/wps', **kwargs)#

Retrieve a horizon elevation profile from the MINES ParisTech SRTM web service.

Parameters:
  • latitude (float) – in decimal degrees, between -90 and 90, north is positive (ISO 19115)

  • longitude (float) – in decimal degrees, between -180 and 180, east is positive (ISO 19115)

  • altitude (float, optional) – Altitude in meters. If None, then the altitude is determined from the NASA SRTM database.

  • ground_offset (float, optional) – Vertical offset in meters for the point of view for which to calculate horizon profile. Default is 0.

  • url (str, default: ‘http://toolbox.1.webservice-energy.org/service/wps’) – Base URL for MINES ParisTech horizon profile API

  • kwargs – Additional keyword arguments passed to requests.get.

Returns:

  • horizon (pd.Series) – Pandas Series of the retrived horizon elevation angles. Index is the corresponding horizon azimuth angles.

  • metadata (dict) – Dictionary with keys 'data_provider', 'database', 'latitude', 'longitude', 'altitude', 'ground_offset'.

Return type:

tuple[Series, dict]

Notes

The azimuthal resolution is one degree. Also, the returned horizon elevations can also be negative.

Examples

Retrieve the horizon profile for Paris, France:

>>> import solarpy
>>> horizon, meta = solarpy.horizon.get_horizon_mines(
...     latitude=48.8566, longitude=2.3522, timeout=10)