spacetime-daylight
Version:
calculate approximate sunlight times for a given timezone
507 lines (392 loc) • 13.5 kB
JavaScript
/* spencermountain/spacetime-daylight 1.5.2 MIT */
import spacetimeGeo from 'spacetime-geo';
function createCommonjsModule(fn, module) {
return module = { exports: {} }, fn(module, module.exports), module.exports;
}
var suncalc = createCommonjsModule(function (module, exports) {
/*
(c) 2011-2015, Vladimir Agafonkin
SunCalc is a JavaScript library for calculating sun/moon position and light phases.
https://github.com/mourner/suncalc
*/
(function () {
// shortcuts for easier to read formulas
var PI = Math.PI,
sin = Math.sin,
cos = Math.cos,
tan = Math.tan,
asin = Math.asin,
atan = Math.atan2,
acos = Math.acos,
rad = PI / 180;
// sun calculations are based on http://aa.quae.nl/en/reken/zonpositie.html formulas
// date/time constants and conversions
var dayMs = 1000 * 60 * 60 * 24,
J1970 = 2440588,
J2000 = 2451545;
function toJulian(date) { return date.valueOf() / dayMs - 0.5 + J1970; }
function fromJulian(j) { return new Date((j + 0.5 - J1970) * dayMs); }
function toDays(date) { return toJulian(date) - J2000; }
// general calculations for position
var e = rad * 23.4397; // obliquity of the Earth
function rightAscension(l, b) { return atan(sin(l) * cos(e) - tan(b) * sin(e), cos(l)); }
function declination(l, b) { return asin(sin(b) * cos(e) + cos(b) * sin(e) * sin(l)); }
function azimuth(H, phi, dec) { return atan(sin(H), cos(H) * sin(phi) - tan(dec) * cos(phi)); }
function altitude(H, phi, dec) { return asin(sin(phi) * sin(dec) + cos(phi) * cos(dec) * cos(H)); }
function siderealTime(d, lw) { return rad * (280.16 + 360.9856235 * d) - lw; }
function astroRefraction(h) {
if (h < 0) // the following formula works for positive altitudes only.
h = 0; // if h = -0.08901179 a div/0 would occur.
// formula 16.4 of "Astronomical Algorithms" 2nd edition by Jean Meeus (Willmann-Bell, Richmond) 1998.
// 1.02 / tan(h + 10.26 / (h + 5.10)) h in degrees, result in arc minutes -> converted to rad:
return 0.0002967 / Math.tan(h + 0.00312536 / (h + 0.08901179));
}
// general sun calculations
function solarMeanAnomaly(d) { return rad * (357.5291 + 0.98560028 * d); }
function eclipticLongitude(M) {
var C = rad * (1.9148 * sin(M) + 0.02 * sin(2 * M) + 0.0003 * sin(3 * M)), // equation of center
P = rad * 102.9372; // perihelion of the Earth
return M + C + P + PI;
}
function sunCoords(d) {
var M = solarMeanAnomaly(d),
L = eclipticLongitude(M);
return {
dec: declination(L, 0),
ra: rightAscension(L, 0)
};
}
var SunCalc = {};
// calculates sun position for a given date and latitude/longitude
SunCalc.getPosition = function (date, lat, lng) {
var lw = rad * -lng,
phi = rad * lat,
d = toDays(date),
c = sunCoords(d),
H = siderealTime(d, lw) - c.ra;
return {
azimuth: azimuth(H, phi, c.dec),
altitude: altitude(H, phi, c.dec)
};
};
// sun times configuration (angle, morning name, evening name)
var times = SunCalc.times = [
[-0.833, 'sunrise', 'sunset' ],
[ -0.3, 'sunriseEnd', 'sunsetStart' ],
[ -6, 'dawn', 'dusk' ],
[ -12, 'nauticalDawn', 'nauticalDusk'],
[ -18, 'nightEnd', 'night' ],
[ 6, 'goldenHourEnd', 'goldenHour' ]
];
// adds a custom time to the times config
SunCalc.addTime = function (angle, riseName, setName) {
times.push([angle, riseName, setName]);
};
// calculations for sun times
var J0 = 0.0009;
function julianCycle(d, lw) { return Math.round(d - J0 - lw / (2 * PI)); }
function approxTransit(Ht, lw, n) { return J0 + (Ht + lw) / (2 * PI) + n; }
function solarTransitJ(ds, M, L) { return J2000 + ds + 0.0053 * sin(M) - 0.0069 * sin(2 * L); }
function hourAngle(h, phi, d) { return acos((sin(h) - sin(phi) * sin(d)) / (cos(phi) * cos(d))); }
function observerAngle(height) { return -2.076 * Math.sqrt(height) / 60; }
// returns set time for the given sun altitude
function getSetJ(h, lw, phi, dec, n, M, L) {
var w = hourAngle(h, phi, dec),
a = approxTransit(w, lw, n);
return solarTransitJ(a, M, L);
}
// calculates sun times for a given date, latitude/longitude, and, optionally,
// the observer height (in meters) relative to the horizon
SunCalc.getTimes = function (date, lat, lng, height) {
height = height || 0;
var lw = rad * -lng,
phi = rad * lat,
dh = observerAngle(height),
d = toDays(date),
n = julianCycle(d, lw),
ds = approxTransit(0, lw, n),
M = solarMeanAnomaly(ds),
L = eclipticLongitude(M),
dec = declination(L, 0),
Jnoon = solarTransitJ(ds, M, L),
i, len, time, h0, Jset, Jrise;
var result = {
solarNoon: fromJulian(Jnoon),
nadir: fromJulian(Jnoon - 0.5)
};
for (i = 0, len = times.length; i < len; i += 1) {
time = times[i];
h0 = (time[0] + dh) * rad;
Jset = getSetJ(h0, lw, phi, dec, n, M, L);
Jrise = Jnoon - (Jset - Jnoon);
result[time[1]] = fromJulian(Jrise);
result[time[2]] = fromJulian(Jset);
}
return result;
};
// moon calculations, based on http://aa.quae.nl/en/reken/hemelpositie.html formulas
function moonCoords(d) { // geocentric ecliptic coordinates of the moon
var L = rad * (218.316 + 13.176396 * d), // ecliptic longitude
M = rad * (134.963 + 13.064993 * d), // mean anomaly
F = rad * (93.272 + 13.229350 * d), // mean distance
l = L + rad * 6.289 * sin(M), // longitude
b = rad * 5.128 * sin(F), // latitude
dt = 385001 - 20905 * cos(M); // distance to the moon in km
return {
ra: rightAscension(l, b),
dec: declination(l, b),
dist: dt
};
}
SunCalc.getMoonPosition = function (date, lat, lng) {
var lw = rad * -lng,
phi = rad * lat,
d = toDays(date),
c = moonCoords(d),
H = siderealTime(d, lw) - c.ra,
h = altitude(H, phi, c.dec),
// formula 14.1 of "Astronomical Algorithms" 2nd edition by Jean Meeus (Willmann-Bell, Richmond) 1998.
pa = atan(sin(H), tan(phi) * cos(c.dec) - sin(c.dec) * cos(H));
h = h + astroRefraction(h); // altitude correction for refraction
return {
azimuth: azimuth(H, phi, c.dec),
altitude: h,
distance: c.dist,
parallacticAngle: pa
};
};
// calculations for illumination parameters of the moon,
// based on http://idlastro.gsfc.nasa.gov/ftp/pro/astro/mphase.pro formulas and
// Chapter 48 of "Astronomical Algorithms" 2nd edition by Jean Meeus (Willmann-Bell, Richmond) 1998.
SunCalc.getMoonIllumination = function (date) {
var d = toDays(date || new Date()),
s = sunCoords(d),
m = moonCoords(d),
sdist = 149598000, // distance from Earth to Sun in km
phi = acos(sin(s.dec) * sin(m.dec) + cos(s.dec) * cos(m.dec) * cos(s.ra - m.ra)),
inc = atan(sdist * sin(phi), m.dist - sdist * cos(phi)),
angle = atan(cos(s.dec) * sin(s.ra - m.ra), sin(s.dec) * cos(m.dec) -
cos(s.dec) * sin(m.dec) * cos(s.ra - m.ra));
return {
fraction: (1 + cos(inc)) / 2,
phase: 0.5 + 0.5 * inc * (angle < 0 ? -1 : 1) / Math.PI,
angle: angle
};
};
function hoursLater(date, h) {
return new Date(date.valueOf() + h * dayMs / 24);
}
// calculations for moon rise/set times are based on http://www.stargazing.net/kepler/moonrise.html article
SunCalc.getMoonTimes = function (date, lat, lng, inUTC) {
var t = new Date(date);
if (inUTC) t.setUTCHours(0, 0, 0, 0);
else t.setHours(0, 0, 0, 0);
var hc = 0.133 * rad,
h0 = SunCalc.getMoonPosition(t, lat, lng).altitude - hc,
h1, h2, rise, set, a, b, xe, ye, d, roots, x1, x2, dx;
// go in 2-hour chunks, each time seeing if a 3-point quadratic curve crosses zero (which means rise or set)
for (var i = 1; i <= 24; i += 2) {
h1 = SunCalc.getMoonPosition(hoursLater(t, i), lat, lng).altitude - hc;
h2 = SunCalc.getMoonPosition(hoursLater(t, i + 1), lat, lng).altitude - hc;
a = (h0 + h2) / 2 - h1;
b = (h2 - h0) / 2;
xe = -b / (2 * a);
ye = (a * xe + b) * xe + h1;
d = b * b - 4 * a * h1;
roots = 0;
if (d >= 0) {
dx = Math.sqrt(d) / (Math.abs(a) * 2);
x1 = xe - dx;
x2 = xe + dx;
if (Math.abs(x1) <= 1) roots++;
if (Math.abs(x2) <= 1) roots++;
if (x1 < -1) x1 = x2;
}
if (roots === 1) {
if (h0 < 0) rise = i + x1;
else set = i + x1;
} else if (roots === 2) {
rise = i + (ye < 0 ? x2 : x1);
set = i + (ye < 0 ? x1 : x2);
}
if (rise && set) break;
h0 = h2;
}
var result = {};
if (rise) result.rise = hoursLater(t, rise);
if (set) result.set = hoursLater(t, set);
if (!rise && !set) result[ye > 0 ? 'alwaysUp' : 'alwaysDown'] = true;
return result;
};
// export as Node module / AMD module / browser variable
module.exports = SunCalc;
}());
});
function toDegree(radians) {
let pi = Math.PI;
return radians * (180 / pi)
}
const sunPosition = function (s, lat, lng) {
if (lat === undefined || lng === undefined) {
let guess = s.point();
lat = guess.lat;
lng = guess.lng;
}
if (!lat || !lng) {
return {}
}
s.in = s.in || spacetimeGeo.in; //bolt-on the plugin
s = s.in(lat, lng);
let d = new Date(s.epoch);
let res = suncalc.getPosition(d, lat, lng);
// return res
return {
azimuth: toDegree(res.azimuth),
altitude: toDegree(res.altitude),
}
};
// the average time between solstices, on timeanddate.com
// approx 88 days, 23 hours, 30 mins
const oneYear = 31557060000;
const halfYear = 15855660000;
// strangely, this does not seem to be exactly half.
// const halfYear = oneYear / 2
// the 2015 winter solstice
const oneWinter = 1450759620000;
const goForward = function (epoch) {
let num = oneWinter + oneYear;
while (num < epoch) {
num += oneYear;
}
return num
};
const goBackward = function (epoch) {
let num = oneWinter - oneYear;
while (num > epoch) {
num -= oneYear;
}
return num
};
const solstice = function (s) {
let found = null;
if (s.epoch > oneWinter) {
found = goForward(s.epoch);
} else {
found = goBackward(s.epoch);
}
let winter = s.set(found);
// ensure it's the right year
if (winter.year() < s.year()) {
winter = winter.set(winter.epoch + oneYear);
}
if (winter.year() > s.year()) {
winter = winter.set(winter.epoch - oneYear);
}
let summer = winter.set(winter.epoch - halfYear);
return {
winter: winter,
summer: summer,
}
};
const setFrom = function (s, time) {
let d = new Date(time);
// console.log(time)
s = s.clone();
s.epoch = d.getTime();
return s
};
const calculatePoint = function (s, lat, lng, field) {
if (lat === undefined || lng === undefined) {
let guess = s.point();
lat = guess.lat;
lng = guess.lng;
}
s.in = s.in || spacetimeGeo.in; //bolt-on the plugin
s = s.in(lat, lng);
let d = new Date(s.epoch);
let res = suncalc.getTimes(d, lat, lng);
return setFrom(s, res[field])
};
var index = {
//depend on this plugin
in: spacetimeGeo.in,
point: spacetimeGeo.point,
solstice: function () {
return solstice(this)
},
winterSolstice: function () {
return solstice(this).winter
},
summerSolstice: function () {
return solstice(this).summer
},
sunPosition: function (lat, lng) {
return sunPosition(this, lat, lng)
},
sunrise: function (lat, lng) {
return calculatePoint(this, lat, lng, 'sunrise')
},
sunset: function (lat, lng) {
return calculatePoint(this, lat, lng, 'sunset')
},
noon: function (lat, lng) {
return calculatePoint(this, lat, lng, 'solarNoon')
},
dawn: function (lat, lng) {
return calculatePoint(this, lat, lng, 'dawn')
},
dusk: function (lat, lng) {
return calculatePoint(this, lat, lng, 'dusk')
},
daylight: function (lat, lng) {
let sunrise = this.sunrise(lat, lng);
let sunset = this.sunset(lat, lng);
let delta = sunset.since(sunrise);
//clean this up a bit
let duration = {
hours: delta.diff.hours,
minutes: delta.diff.minutes,
seconds: delta.diff.seconds,
};
let diff = sunrise.diff(sunset);
diff.seconds = parseInt((sunset.epoch - sunrise.epoch) / 1000, 10);
let now = sunrise.diff(this);
now.seconds = parseInt((this.epoch - sunrise.epoch) / 1000, 10);
let progress = now.seconds / diff.seconds;
let status = 'day';
let dawn = this.dawn();
let dusk = this.dusk();
if (progress < 0) {
progress = 0;
if (this.epoch > dawn.epoch) {
status = 'dawn';
} else {
status = 'night';
}
} else if (progress > 1) {
progress = 0;
if (this.epoch < dusk.epoch) {
status = 'dusk';
} else {
status = 'night';
}
}
return {
dawn: dawn.time(),
sunrise: sunrise.time(),
sunset: sunset.time(),
dusk: dusk.time(),
duration: {
inHours: diff.hours,
inMinutes: diff.minutes,
inSeconds: diff.seconds,
human: duration,
},
current: {
progress: progress,
status: status,
},
}
},
};
export { index as default };