vlf4ions.sunrise_sunset

Created on Tue Apr 1 17:10:28 2025

@author: pteysseyre

Functions

check_if_daytime(today, path)	Check whether the current time is greater than the sunrise time and less than sunset for this particular station and day
get_sunrise_sunset(today, path)	Returns the sunrise (civil + 1 hr) and sunset (civil - 1 hr) times (in UT)
get_sza(today, lat, lon)	Returns the solar zenith angle (in rad) at the latitude/longitude given in input
is_daytime(this_station, this_receiver, ...)	Check if the solar zenith angle at the station and the receiver is less than sza_threshold.

vlf4ions.sunrise_sunset.get_sza(today, lat, lon)

Returns the solar zenith angle (in rad) at the latitude/longitude given in input

Parameters:

• today – Datetime for the time of interest

• lat – Latitude of interest (in °)

• lon – Longitude of interest (in °)

Returns:

sza, solar zenith angle (in rad)

vlf4ions.sunrise_sunset.get_sunrise_sunset(today, path)

Returns the sunrise (civil + 1 hr) and sunset (civil - 1 hr) times (in UT)

Parameters:

• today – datetime (may only contain the year, month and day)

• path – path to the precomputed sunrise/sunset times

Returns:

sunrise and sunset times for this day (in UT)

vlf4ions.sunrise_sunset.check_if_daytime(today, path)

Check whether the current time is greater than the sunrise time and less than sunset for this particular station and day

Parameters:

• today – datetime (may only contain the year, month and day)

• path – path to the precomputed sunrise/sunset times

Returns:

Boolean, if we are in daytime

vlf4ions.sunrise_sunset.is_daytime(this_station, this_receiver, today, sza_threshold)

Check if the solar zenith angle at the station and the receiver is less than sza_threshold. Return True if this is the case, signaling that it is daytime

Parameters:

• this_station – Station class instance

• this_receiver – Receiver class instance

• today – Datetime, time of the computation. Must be timezone-aware

• sza_threshold – Solar zenith angle threshold below which it is daytime (Default: 85°)

Returns:

• daytime: Boolean, is true if it is daytime.

• Sza, mean solar zenith angle (in rad) between the transmitter and the receiver