# -*- coding: utf-8 -*- # Copyright Brandon Stafford # # This file is part of Pysolar. # # Pysolar is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # Pysolar is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License along # with Pysolar. If not, see . """Additional support functions for solar geometry, astronomy, radiation correlation :Original author: Simeon Nwaogaidu :Contact: SimeonObinna.Nwaogaidu AT lahmeyer DOT de :Additional author: Holger Zebner :Contact: holger.zebner AT lahmeyer DOT de :Additional author: Brandon Stafford """ from datetime import \ datetime, \ timedelta from . import numeric as math from . import solar, constants from .tzinfo_check import check_aware_dt # Some default constants AM_default = 2.0 # Default air mass is 2.0 TL_default = 1.0 # Default Linke turbidity factor is 1.0 SC_default = 1367.0 # Solar constant in W/m^2 is 1367.0. Note that this value could vary by +/-4 W/m^2 TY_default = 365 # Total year number from 1 to 365 days elevation_default = 0.0 # Default elevation is 0.0 # Useful equations for analysis @check_aware_dt('when') def get_sunrise_sunset_transit(latitude_deg, longitude_deg, when): """This function calculates the astronomical sunrise, sunset and sun transit times in local time. Parameters ---------- latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. when : datetime.datetime date and time in any valid timezone, answers will be for same day in same timezone. Returns ------- sunrise_time_dt : datetime.datetime Sunrise time in local time. sunset_time_dt : datetime.datetime Sunset time in local time. transit_time_dt: Sun transit time in local time. References ---------- .. [1] http://www.skypowerinternational.com/uploads/documents/7.1415.01.121_cm121_bed-anleitung_engl.pdf .. [2] http://pysolar.org/ .. [3] https://www.esrl.noaa.gov/gmd/grad/solcalc/solareqns.PDF .. [4] https://www.sciencedirect.com/science/article/pii/S0038092X11004592 .. [5] https://iris.unipa.it/retrieve/handle/10447/55143/28818/Articolo.pdf Examples -------- >>> lat = 50.111512 >>> lon = 8.680506 >>> timezone_local = dateutil.tz.gettz('Europe/Berlin') >>> now = datetime.now(timezone_local) >>> sr, ss, tr = sb.get_sunrise_sunset_transit(lat, lon, now) >>> print('sunrise: ', sr) >>> print('sunset:', ss) >>> print('transit:', tr) """ utc_offset = when.utcoffset() if utc_offset != None : utc_offset = utc_offset.total_seconds() else : utc_offset = 0 #end if day = when.utctimetuple().tm_yday # Day of the year SHA = utc_offset / 3600 * 15.0 - longitude_deg # Solar hour angle TT = 2 * math.pi * day / 366 decl = \ ( 0.322003 - 22.971 * math.cos(TT) - 0.357898 * math.cos(2 * TT) - 0.14398 * math.cos(3 * TT) + 3.94638 * math.sin(TT) + 0.019334 * math.sin(2 * TT) + 0.05928 * math.sin(3 * TT) ) # solar declination in degrees TT = math.radians(279.134 + 0.985647 * day) # Time adjustment angle time_adst = \ ( ( 5.0323 - 100.976 * math.sin(TT) + 595.275 * math.sin(2 * TT) + 3.6858 * math.sin(3 * TT) - 12.47 * math.sin(4 * TT) - 430.847 * math.cos(TT) + 12.5024 * math.cos(2 * TT) + 18.25 * math.cos(3 * TT) ) / 3600 ) # Time adjustment in hours TON = 12 + SHA / 15.0 - time_adst # Time of noon ha = \ ( math.acos( math.cos(math.radians(90.833)) / ( math.cos(math.radians(latitude_deg)) * math.cos(math.radians(decl)) ) - math.tan(math.radians(latitude_deg)) * math.tan(math.radians(decl)) ) * (12 / math.pi) ) same_day = datetime(year = when.year, month = when.month, day = when.day, tzinfo = when.tzinfo) sunrise_time = same_day + timedelta(hours = TON - ha) sunset_time = same_day + timedelta(hours = TON + ha) transit_time = same_day + timedelta(hours = TON) return sunrise_time, sunset_time, transit_time @check_aware_dt('when') def get_sunrise_sunset(latitude_deg, longitude_deg, when): "Wrapper for get_sunrise_sunset_transit that returns just the sunrise and the sunset time." return \ get_sunrise_sunset_transit(latitude_deg, longitude_deg, when)[0:2] @check_aware_dt('when') def get_sunrise_time(latitude_deg, longitude_deg, when): "Wrapper for get_sunrise_sunset_transit that returns just the sunrise time." return \ get_sunrise_sunset_transit(latitude_deg, longitude_deg, when)[0] @check_aware_dt('when') def get_sunset_time(latitude_deg, longitude_deg, when): "Wrapper for get_sunrise_sunset_transit that returns just the sunset time." return \ get_sunrise_sunset_transit(latitude_deg, longitude_deg, when)[1] @check_aware_dt('when') def get_transit_time(latitude_deg, longitude_deg, when): "Wrapper for get_sunrise_sunset_transit that returns just the transit time." return \ get_sunrise_sunset_transit(latitude_deg, longitude_deg, when)[2] @check_aware_dt('when') def mean_earth_sun_distance(when): """Mean Earth-Sun distance is the arithmetical mean of the maximum and minimum distances between a planet (Earth) and the object about which it revolves (Sun). However, the function is used to calculate the Mean earth sun distance. Parameters ---------- when : datetime.datetime date/time for which to do the calculation Returns ------- KD : float Mean earth sun distance References ---------- .. [1] http://sunbird.jrc.it/pvgis/solres/solmod3.htm#clear-sky%20radiation .. [2] R. aguiar and et al, "The ESRA user guidebook, vol. 2. database", models and exploitation software-Solar radiation models, p.113 """ return 1 - 0.0335 * math.sin(2 * math.pi * (when.utctimetuple().tm_yday - 94)) / 365 @check_aware_dt('when') def extraterrestrial_irrad(latitude_deg, longitude_deg, when, SC=SC_default): """Equation calculates Extratrestrial radiation. Solar radiation incident outside the earth's atmosphere is called extraterrestrial radiation. On average the extraterrestrial irradiance is 1367 Watts/meter2 (W/m2). This value varies by + or - 3 percent as the earth orbits the sun. The earth's closest approach to the sun occurs around January 4th and it is furthest from the sun around July 5th. Parameters ---------- when : datetime.datetime date/time for which to do the calculation latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. SC : float The solar constant is the amount of incoming solar electromagnetic radiation per unit area, measured on the outer surface of Earth's atmosphere in a plane perpendicular to the rays.It is measured by satellite to be roughly 1366 watts per square meter (W/m^2) Returns ------- EXTR1 : float Extraterrestrial irradiation References ---------- .. [1] http://solardat.uoregon.edu/SolarRadiationBasics.html .. [2] Dr. J. Schumacher and et al,"INSEL LE(Integrated Simulation Environment Language)Block reference",p.68 """ day = when.utctimetuple().tm_yday ab = math.cos(2 * math.pi * (day - 1.0)/(365.0)) bc = math.sin(2 * math.pi * (day - 1.0)/(365.0)) cd = math.cos(2 * (2 * math.pi * (day - 1.0)/(365.0))) df = math.sin(2 * (2 * math.pi * (day - 1.0)/(365.0))) decl = math.radians(solar.get_declination(day)) ha = math.radians(solar.get_hour_angle(when, longitude_deg)) ZA = math.sin(math.radians(latitude_deg)) * math.sin(decl) + math.cos(math.radians(latitude_deg)) * math.cos(decl) * math.cos(ha) return SC * ZA * (1.00010 + 0.034221 * ab + 0.001280 * bc + 0.000719 * cd + 0.000077 * df) if ZA > 0 else 0.0 @check_aware_dt('when') def declination_degree(when, TY = TY_default): """The declination of the sun is the angle between Earth's equatorial plane and a line between the Earth and the sun. It varies between 23.45 degrees and -23.45 degrees, hitting zero on the equinoxes and peaking on the solstices. Parameters ---------- when : datetime.datetime date/time for which to do the calculation TY : float Total number of days in a year. eg. 365 days per year,(no leap days) Returns ------- DEC : float The declination of the Sun References ---------- .. [1] http://pysolar.org/ """ return constants.earth_axis_inclination * math.sin((2 * math.pi / (TY)) * ((when.utctimetuple().tm_yday) - 81)) @check_aware_dt('when') def solarelevation_function_clear(latitude_deg, longitude_deg, when, temperature = constants.standard_temperature, pressure = constants.standard_pressure, elevation = elevation_default): """Equation calculates Solar elevation function for clear sky type. Parameters ---------- latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. when : datetime.datetime date/time for which to do the calculation temperature : float atmospheric temperature pressure : float pressure in pascals elevation : float The elevation of a geographic location is its height above a fixed reference point, often the mean sea level. Returns ------- SOLALTC : float Solar elevation function clear sky References ---------- .. [1] S. Younes, R.Claywell and el al,"Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ altitude = solar.get_altitude(latitude_deg, longitude_deg,when, elevation, temperature,pressure) return (0.038175 + (1.5458 * (math.sin(altitude))) + ((-0.59980) * (0.5 * (1 - math.cos(2 * (altitude)))))) @check_aware_dt('when') def solarelevation_function_overcast(latitude_deg, longitude_deg, when, elevation = elevation_default, temperature = constants.standard_temperature, pressure = constants.standard_pressure): """ The function calculates solar elevation function for overcast sky type. This associated hourly overcast radiation model is based on the estimation of the overcast sky transmittance with the sun directly overhead combined with the application of an over sky elavation function to estimate the overcast day global irradiation value at any solar elevation. Parameters ---------- latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. when : datetime.datetime date/time for which to do the calculation elevation : float The elevation of a geographic location is its height above a fixed reference point, often the mean sea level. temperature : float atmospheric temperature pressure : float pressure in pascals Returns ------- SOLALTO : float Solar elevation function overcast References ---------- .. [1] Prof. Peter Tregenza,"Solar radiation and daylight models", p.89. .. [2] Also accessible through Google Books: http://tinyurl.com/5kdbwu Tariq Muneer, "Solar Radiation and Daylight Models, Second Edition: For the Energy Efficient Design of Buildings" """ altitude = solar.get_altitude(latitude_deg, longitude_deg,when, elevation, temperature,pressure) return ((-0.0067133) + (0.78600 * (math.sin(altitude)))) + (0.22401 * (0.5 * (1 - math.cos(2 * altitude)))) def diffuse_transmittance(TL = TL_default): """Equation calculates the Diffuse_transmittance and the is the Theoretical Diffuse Irradiance on a horizontal surface when the sun is at the zenith. Parameters ---------- TL : float Linke turbidity factor Returns ------- DT : float diffuse_transmittance References ---------- .. [1] S. Younes, R.Claywell and el al,"Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ return ((-21.657) + (41.752 * (TL)) + (0.51905 * (TL) * (TL))) @check_aware_dt('when') def diffuse_underclear(latitude_deg, longitude_deg, when, elevation = elevation_default, temperature = constants.standard_temperature, pressure = constants.standard_pressure, TL=TL_default): """Equation calculates diffuse radiation under clear sky conditions. Parameters ---------- latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. when : datetime.datetime date/time for which to do the calculation elevation : float The elevation of a geographic location is its height above a fixed reference point, often the mean sea level. temperature : float atmospheric temperature pressure : float pressure in pascals TL : float Linke turbidity factor Returns ------- DIFFC : float Diffuse Irradiation under clear sky References ---------- .. [1] S. Younes, R.Claywell and el al,"Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ DT = ((-21.657) + (41.752 * (TL)) + (0.51905 * (TL) * (TL))) altitude = solar.get_altitude(latitude_deg, longitude_deg,when, elevation, temperature,pressure) return mean_earth_sun_distance(when) * DT * altitude @check_aware_dt('when') def diffuse_underovercast(latitude_deg, longitude_deg, when, elevation = elevation_default, temperature = constants.standard_temperature, pressure = constants.standard_pressure,TL=TL_default): """Function calculates the diffuse radiation under overcast conditions. Parameters ---------- latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. when : datetime.datetime date/time for which to do the calculation elevation : float The elevation of a geographic location is its height above a fixed reference point, often the mean sea level. temperature : float atmospheric temperature pressure : float pressure in pascals TL : float Linke turbidity factor Returns ------- DIFOC : float Diffuse Irradiation under overcast References ---------- .. [1] S. Younes, R.Claywell and el al,"Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ DT = ((-21.657) + (41.752 * (TL)) + (0.51905 * (TL) * (TL))) DIFOC = ((mean_earth_sun_distance(when) )*(DT)*(solar.get_altitude(latitude_deg,longitude_deg, when, elevation, temperature, pressure))) return DIFOC @check_aware_dt('when') def direct_underclear(latitude_deg, longitude_deg, when, TY = TY_default, AM = AM_default, TL = TL_default, elevation = elevation_default, temperature = constants.standard_temperature, pressure = constants.standard_pressure): """Equation calculates direct radiation under clear sky conditions. Parameters ---------- latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. when : datetime.datetime date/time for which to do the calculation TY : float Total number of days in a year. eg. 365 days per year,(no leap days) AM : float Air mass. An Air Mass is a measure of how far light travels through the Earth's atmosphere. One air mass, or AM1, is the thickness of the Earth's atmosphere. Air mass zero (AM0) describes solar irradiance in space, where it is unaffected by the atmosphere. The power density of AM1 light is about 1,000 W/m^2 TL : float Linke turbidity factor elevation : float The elevation of a geographic location is its height above a fixed reference point, often the mean sea level. temperature : float atmospheric temperature pressure : float pressure in pascals Returns ------- DIRC : float Direct Irradiation under clear References ---------- .. [1] S. Younes, R.Claywell and el al,"Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ KD = mean_earth_sun_distance(when) DEC = declination_degree(when,TY) DIRC = (1367 * KD * math.exp(-0.8662 * (AM) * (TL) * (DEC) ) * math.sin(solar.get_altitude(latitude_deg,longitude_deg, when,elevation , temperature , pressure ))) return DIRC @check_aware_dt('when') def global_irradiance_clear(latitude_deg, longitude_deg, when, TY = TY_default, AM = AM_default, TL = TL_default, elevation = elevation_default, temperature = constants.standard_temperature, pressure = constants.standard_pressure): """Equation calculates global irradiance under clear sky conditions. Parameters ---------- latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. when : datetime.datetime date/time for which to do the calculation temperature : float atmospheric temperature pressure : float pressure in pascals elevation : float The elevation of a geographic location is its height above a fixed reference point, often the mean sea level. TY : float Total number of days in a year. eg. 365 days per year,(no leap days) AM : float Air mass. An Air Mass is a measure of how far light travels through the Earth's atmosphere. One air mass, or AM1, is the thickness of the Earth's atmosphere. Air mass zero (AM0) describes solar irradiance in space, where it is unaffected by the atmosphere. The power density of AM1 light is about 1,000 W/m. TL : float Linke turbidity factor elevation : float The elevation of a geographic location is its height above a fixed reference point, often the mean sea level. Returns ------- ghic : float Global Irradiation under clear sky References ---------- .. [1] S. Younes, R.Claywell and el al,"Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ DIRC = direct_underclear(latitude_deg, longitude_deg, when, TY, AM, TL, elevation, temperature = constants.standard_temperature, pressure = constants.standard_pressure) DIFFC = diffuse_underclear(latitude_deg, longitude_deg, when, elevation, temperature = constants.standard_temperature, pressure= constants.standard_pressure) ghic = (DIRC + DIFFC) return ghic @check_aware_dt('when') def global_irradiance_overcast(latitude_deg, longitude_deg, when, elevation = elevation_default, temperature = constants.standard_temperature, pressure = constants.standard_pressure): """Calculated Global is used to compare to the Diffuse under overcast conditions. Under overcast skies, global and diffuse are expected to be equal due to the absence of the beam component. Parameters ---------- latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. when : datetime.datetime date/time for which to do the calculation elevation : float The elevation of a geographic location is its height above a fixed reference point, often the mean sea level. temperature : float atmospheric temperature pressure : float pressure in pascals Returns ------- ghioc : float Global Irradiation under overcast sky References ---------- .. [1] S. Younes, R.Claywell and el al, "Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ ghioc = (572 * (solar.get_altitude(latitude_deg, longitude_deg, when, elevation , temperature , pressure ))) return ghioc def diffuse_ratio(DIFF_data, ghi_data): """Function calculates the Diffuse ratio. Parameters ---------- DIFF_data : array_like Diffuse horizontal irradiation data ghi_data : array_like global horizontal irradiation data array Returns ------- K : float diffuse_ratio References ---------- .. [1] S. Younes, R.Claywell and el al,"Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ K = DIFF_data/ghi_data return K @check_aware_dt('when') def clear_index(ghi_data, latitude_deg, longitude_deg, when): """This calculates the clear index ratio. Parameters ---------- ghi_data : array_like global horizontal irradiation data array when : datetime.datetime date/time for which to do the calculation latitude_deg : float latitude in decimal degree. A geographical term denoting the north/south angular location of a place on a sphere. longitude_deg : float longitude in decimal degree. Longitude shows your location in an east-west direction,relative to the Greenwich meridian. Returns ------- KT : float Clear index ratio References ---------- .. [1] S. Younes, R.Claywell and el al,"Quality control of solar radiation data: present status and proposed new approaches", energy 30 (2005), pp 1533 - 1549. """ EXTR1 = extraterrestrial_irrad(latitude_deg, longitude_deg, when) KT = (ghi_data / EXTR1) return KT