Add a regression test for Bug#30004.
[emacs.git] / lisp / calendar / solar.el
blobddaf7451bd90155d0921da84e3dc24861bbe6fe7
1 ;;; solar.el --- calendar functions for solar events -*- lexical-binding:t -*-
3 ;; Copyright (C) 1992-1993, 1995, 1997, 2001-2018 Free Software
4 ;; Foundation, Inc.
6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
7 ;; Denis B. Roegel <Denis.Roegel@loria.fr>
8 ;; Maintainer: Glenn Morris <rgm@gnu.org>
9 ;; Keywords: calendar
10 ;; Human-Keywords: sunrise, sunset, equinox, solstice, calendar, diary, holidays
11 ;; Package: calendar
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
28 ;;; Commentary:
30 ;; See calendar.el. This file implements features that deal with
31 ;; times of day, sunrise/sunset, and equinoxes/solstices.
33 ;; Based on the ``Almanac for Computers 1984,'' prepared by the Nautical
34 ;; Almanac Office, United States Naval Observatory, Washington, 1984, on
35 ;; ``Astronomical Formulae for Calculators,'' 3rd ed., by Jean Meeus,
36 ;; Willmann-Bell, Inc., 1985, on ``Astronomical Algorithms'' by Jean Meeus,
37 ;; Willmann-Bell, Inc., 1991, and on ``Planetary Programs and Tables from
38 ;; -4000 to +2800'' by Pierre Bretagnon and Jean-Louis Simon, Willmann-Bell,
39 ;; Inc., 1986.
42 ;; Accuracy:
43 ;; 1. Sunrise/sunset times will be accurate to the minute for years
44 ;; 1951--2050. For other years the times will be within +/- 2 minutes.
46 ;; 2. Equinox/solstice times will be accurate to the minute for years
47 ;; 1951--2050. For other years the times will be within +/- 1 minute.
49 ;;; Code:
51 (require 'calendar)
52 (require 'cal-dst)
53 ;; calendar-astro-to-absolute and v versa are cal-autoloads.
54 ;;;(require 'cal-julian)
57 (defcustom calendar-time-display-form
58 '(12-hours ":" minutes am-pm
59 (if time-zone " (") time-zone (if time-zone ")"))
60 "The pseudo-pattern that governs the way a time of day is formatted.
62 A pseudo-pattern is a list of expressions that can involve the keywords
63 `12-hours', `24-hours', and `minutes', all numbers in string form,
64 and `am-pm' and `time-zone', both alphabetic strings.
66 For example, the form
68 (24-hours \":\" minutes
69 (if time-zone \" (\") time-zone (if time-zone \")\"))
71 would give military-style times like \"21:07 (UTC)\"."
72 :type 'sexp
73 :risky t
74 :group 'calendar)
76 (defcustom calendar-latitude nil
77 "Latitude of `calendar-location-name' in degrees.
78 The value can be either a decimal fraction (one place of accuracy is
79 sufficient), + north, - south, such as 40.7 for New York City, or the value
80 can be a vector [degrees minutes north/south] such as [40 50 north] for New
81 York City.
83 This variable should be set in `site-start'.el."
84 :type '(choice (const nil)
85 (number :tag "Exact")
86 (vector :value [0 0 north]
87 (integer :tag "Degrees")
88 (integer :tag "Minutes")
89 (choice :tag "Position"
90 (const north)
91 (const south))))
92 :group 'calendar)
94 (defcustom calendar-longitude nil
95 "Longitude of `calendar-location-name' in degrees.
96 The value can be either a decimal fraction (one place of accuracy is
97 sufficient), + east, - west, such as -73.9 for New York City, or the value
98 can be a vector [degrees minutes east/west] such as [73 55 west] for New
99 York City.
101 This variable should be set in `site-start'.el."
102 :type '(choice (const nil)
103 (number :tag "Exact")
104 (vector :value [0 0 west]
105 (integer :tag "Degrees")
106 (integer :tag "Minutes")
107 (choice :tag "Position"
108 (const east)
109 (const west))))
110 :group 'calendar)
112 (defcustom calendar-location-name
113 '(let ((float-output-format "%.1f"))
114 (format "%s%s, %s%s"
115 (if (numberp calendar-latitude)
116 (abs calendar-latitude)
117 (+ (aref calendar-latitude 0)
118 (/ (aref calendar-latitude 1) 60.0)))
119 (if (numberp calendar-latitude)
120 (if (> calendar-latitude 0) "N" "S")
121 (if (eq (aref calendar-latitude 2) 'north) "N" "S"))
122 (if (numberp calendar-longitude)
123 (abs calendar-longitude)
124 (+ (aref calendar-longitude 0)
125 (/ (aref calendar-longitude 1) 60.0)))
126 (if (numberp calendar-longitude)
127 (if (> calendar-longitude 0) "E" "W")
128 (if (eq (aref calendar-longitude 2) 'east) "E" "W"))))
129 "Expression evaluating to the name of the calendar location.
130 For example, \"New York City\". The default value is just the
131 variable `calendar-latitude' paired with the variable `calendar-longitude'.
133 This variable should be set in `site-start'.el."
134 :type 'sexp
135 :risky t
136 :group 'calendar)
138 (defcustom solar-error 0.5
139 "Tolerance (in minutes) for sunrise/sunset calculations.
141 A larger value makes the calculations for sunrise/sunset faster, but less
142 accurate. The default is half a minute (30 seconds), so that sunrise/sunset
143 times will be correct to the minute.
145 It is useless to set the value smaller than 4*delta, where delta is the
146 accuracy in the longitude of the sun (given by the function
147 `solar-ecliptic-coordinates') in degrees since (delta/360) x (86400/60) = 4 x
148 delta. At present, delta = 0.01 degrees, so the value of the variable
149 `solar-error' should be at least 0.04 minutes (about 2.5 seconds)."
150 :type 'number
151 :group 'calendar)
153 (defcustom solar-n-hemi-seasons
154 '("Vernal Equinox" "Summer Solstice" "Autumnal Equinox" "Winter Solstice")
155 "List of season changes for the northern hemisphere."
156 :type '(list
157 (string :tag "Vernal Equinox")
158 (string :tag "Summer Solstice")
159 (string :tag "Autumnal Equinox")
160 (string :tag "Winter Solstice"))
161 :group 'calendar)
163 (defcustom solar-s-hemi-seasons
164 '("Autumnal Equinox" "Winter Solstice" "Vernal Equinox" "Summer Solstice")
165 "List of season changes for the southern hemisphere."
166 :type '(list
167 (string :tag "Autumnal Equinox")
168 (string :tag "Winter Solstice")
169 (string :tag "Vernal Equinox")
170 (string :tag "Summer Solstice"))
171 :group 'calendar)
173 ;;; End of user options.
175 (defvar solar-sidereal-time-greenwich-midnight nil
176 "Sidereal time at Greenwich at midnight (Universal Time).")
178 (defvar solar-northern-spring-or-summer-season nil
179 "Non-nil if northern spring or summer and nil otherwise.
180 Needed for polar areas, in order to know whether the day lasts 0 or 24 hours.")
183 (defsubst calendar-latitude ()
184 "Ensure the variable `calendar-latitude' is a signed decimal fraction."
185 (if (numberp calendar-latitude)
186 calendar-latitude
187 (let ((lat (+ (aref calendar-latitude 0)
188 (/ (aref calendar-latitude 1) 60.0))))
189 (if (eq (aref calendar-latitude 2) 'north)
191 (- lat)))))
193 (defsubst calendar-longitude ()
194 "Ensure the variable `calendar-longitude' is a signed decimal fraction."
195 (if (numberp calendar-longitude)
196 calendar-longitude
197 (let ((long (+ (aref calendar-longitude 0)
198 (/ (aref calendar-longitude 1) 60.0))))
199 (if (eq (aref calendar-longitude 2) 'east)
200 long
201 (- long)))))
203 (defun solar-get-number (prompt)
204 "Return a number from the minibuffer, prompting with PROMPT.
205 Returns nil if nothing was entered."
206 (let ((x (read-string prompt "")))
207 (unless (string-equal x "")
208 (string-to-number x))))
210 (defun solar-setup ()
211 "Prompt for `calendar-longitude', `calendar-latitude', `calendar-time-zone'."
212 (beep)
213 (or calendar-longitude
214 (setq calendar-longitude
215 (solar-get-number
216 "Enter longitude (decimal fraction; + east, - west): ")))
217 (or calendar-latitude
218 (setq calendar-latitude
219 (solar-get-number
220 "Enter latitude (decimal fraction; + north, - south): ")))
221 (or calendar-time-zone
222 (setq calendar-time-zone
223 (solar-get-number
224 "Enter difference from Coordinated Universal Time (in minutes): ")
227 (defun solar-sin-degrees (x)
228 "Return sin of X degrees."
229 (sin (degrees-to-radians (mod x 360.0))))
231 (defun solar-cosine-degrees (x)
232 "Return cosine of X degrees."
233 (cos (degrees-to-radians (mod x 360.0))))
235 (defun solar-tangent-degrees (x)
236 "Return tangent of X degrees."
237 (tan (degrees-to-radians (mod x 360.0))))
239 (defun solar-xy-to-quadrant (x y)
240 "Determine the quadrant of the point X, Y."
241 (if (> x 0)
242 (if (> y 0) 1 4)
243 (if (> y 0) 2 3)))
245 (defun solar-degrees-to-quadrant (angle)
246 "Determine the quadrant of ANGLE degrees."
247 (1+ (floor (mod angle 360) 90)))
249 (defun solar-arctan (x quad)
250 "Arctangent of X in quadrant QUAD."
251 (let ((deg (radians-to-degrees (atan x))))
252 (cond ((= quad 2) (+ deg 180))
253 ((= quad 3) (+ deg 180))
254 ((= quad 4) (+ deg 360))
255 (t deg))))
257 (defun solar-atn2 (x y)
258 "Arctangent of point X, Y."
259 (if (zerop x)
260 (if (> y 0) 90 270)
261 (solar-arctan (/ y x) (solar-xy-to-quadrant x y))))
263 (defun solar-arccos (x)
264 "Arccosine of X."
265 (let ((y (sqrt (- 1 (* x x)))))
266 (solar-atn2 x y)))
268 (defun solar-arcsin (y)
269 "Arcsin of Y."
270 (let ((x (sqrt (- 1 (* y y)))))
271 (solar-atn2 x y)))
273 (defsubst solar-degrees-to-hours (degrees)
274 "Convert DEGREES to hours."
275 (/ degrees 15.0))
277 (defsubst solar-hours-to-days (hour)
278 "Convert HOUR to decimal fraction of a day."
279 (/ hour 24.0))
281 (defun solar-right-ascension (longitude obliquity)
282 "Right ascension of the sun, in hours, given LONGITUDE and OBLIQUITY.
283 Both arguments are in degrees."
284 (solar-degrees-to-hours
285 (solar-arctan
286 (* (solar-cosine-degrees obliquity) (solar-tangent-degrees longitude))
287 (solar-degrees-to-quadrant longitude))))
289 (defun solar-declination (longitude obliquity)
290 "Declination of the sun, in degrees, given LONGITUDE and OBLIQUITY.
291 Both arguments are in degrees."
292 (solar-arcsin
293 (* (solar-sin-degrees obliquity)
294 (solar-sin-degrees longitude))))
296 (defun solar-ecliptic-coordinates (time sunrise-flag)
297 "Return solar longitude, ecliptic inclination, equation of time, nutation.
298 Values are for TIME in Julian centuries of Ephemeris Time since
299 January 1st, 2000, at 12 ET. Longitude and inclination are in
300 degrees, equation of time in hours, and nutation in seconds of longitude.
301 If SUNRISE-FLAG is non-nil, only calculate longitude and inclination."
302 (let* ((l (+ 280.46645
303 (* 36000.76983 time)
304 (* 0.0003032 time time))) ; sun mean longitude
305 (ml (+ 218.3165
306 (* 481267.8813 time))) ; moon mean longitude
307 (m (+ 357.52910
308 (* 35999.05030 time)
309 (* -0.0001559 time time)
310 (* -0.00000048 time time time))) ; sun mean anomaly
311 (i (+ 23.43929111 (* -0.013004167 time)
312 (* -0.00000016389 time time)
313 (* 0.0000005036 time time time))) ; mean inclination
314 (c (+ (* (+ 1.914600
315 (* -0.004817 time)
316 (* -0.000014 time time))
317 (solar-sin-degrees m))
318 (* (+ 0.019993 (* -0.000101 time))
319 (solar-sin-degrees (* 2 m)))
320 (* 0.000290
321 (solar-sin-degrees (* 3 m))))) ; center equation
322 (L (+ l c)) ; total longitude
323 ;; Longitude of moon's ascending node on the ecliptic.
324 (omega (+ 125.04
325 (* -1934.136 time)))
326 ;; nut = nutation in longitude, measured in seconds of angle.
327 (nut (unless sunrise-flag
328 (+ (* -17.20 (solar-sin-degrees omega))
329 (* -1.32 (solar-sin-degrees (* 2 l)))
330 (* -0.23 (solar-sin-degrees (* 2 ml)))
331 (* 0.21 (solar-sin-degrees (* 2 omega))))))
332 (ecc (unless sunrise-flag ; eccentricity of earth's orbit
333 (+ 0.016708617
334 (* -0.000042037 time)
335 (* -0.0000001236 time time))))
336 (app (+ L ; apparent longitude of sun
337 -0.00569
338 (* -0.00478
339 (solar-sin-degrees omega))))
340 (y (unless sunrise-flag
341 (* (solar-tangent-degrees (/ i 2))
342 (solar-tangent-degrees (/ i 2)))))
343 ;; Equation of time, in hours.
344 (time-eq (unless sunrise-flag
345 (/ (* 12 (+ (* y (solar-sin-degrees (* 2 l)))
346 (* -2 ecc (solar-sin-degrees m))
347 (* 4 ecc y (solar-sin-degrees m)
348 (solar-cosine-degrees (* 2 l)))
349 (* -0.5 y y (solar-sin-degrees (* 4 l)))
350 (* -1.25 ecc ecc (solar-sin-degrees (* 2 m)))))
351 float-pi))))
352 (list app i time-eq nut)))
354 (defun solar-ephemeris-correction (year)
355 "Ephemeris time minus Universal Time during Gregorian YEAR.
356 Result is in days. For the years 1800-1987, the maximum error is
357 1.9 seconds. For the other years, the maximum error is about 30 seconds."
358 (cond ((and (<= 1988 year) (< year 2020))
359 (/ (+ year -2000 67.0) 60.0 60.0 24.0))
360 ((and (<= 1900 year) (< year 1988))
361 (let* ((theta (/ (- (calendar-astro-from-absolute
362 (calendar-absolute-from-gregorian
363 (list 7 1 year)))
364 (calendar-astro-from-absolute
365 (calendar-absolute-from-gregorian
366 '(1 1 1900))))
367 36525.0))
368 (theta2 (* theta theta))
369 (theta3 (* theta2 theta))
370 (theta4 (* theta2 theta2))
371 (theta5 (* theta3 theta2)))
372 (+ -0.00002
373 (* 0.000297 theta)
374 (* 0.025184 theta2)
375 (* -0.181133 theta3)
376 (* 0.553040 theta4)
377 (* -0.861938 theta5)
378 (* 0.677066 theta3 theta3)
379 (* -0.212591 theta4 theta3))))
380 ((and (<= 1800 year) (< year 1900))
381 (let* ((theta (/ (- (calendar-astro-from-absolute
382 (calendar-absolute-from-gregorian
383 (list 7 1 year)))
384 (calendar-astro-from-absolute
385 (calendar-absolute-from-gregorian
386 '(1 1 1900))))
387 36525.0))
388 (theta2 (* theta theta))
389 (theta3 (* theta2 theta))
390 (theta4 (* theta2 theta2))
391 (theta5 (* theta3 theta2)))
392 (+ -0.000009
393 (* 0.003844 theta)
394 (* 0.083563 theta2)
395 (* 0.865736 theta3)
396 (* 4.867575 theta4)
397 (* 15.845535 theta5)
398 (* 31.332267 theta3 theta3)
399 (* 38.291999 theta4 theta3)
400 (* 28.316289 theta4 theta4)
401 (* 11.636204 theta4 theta5)
402 (* 2.043794 theta5 theta5))))
403 ((and (<= 1620 year) (< year 1800))
404 (let ((x (/ (- year 1600) 10.0)))
405 (/ (+ (* 2.19167 x x) (* -40.675 x) 196.58333) 60.0 60.0 24.0)))
406 (t (let* ((tmp (- (calendar-astro-from-absolute
407 (calendar-absolute-from-gregorian
408 (list 1 1 year)))
409 2382148))
410 (second (- (/ (* tmp tmp) 41048480.0) 15)))
411 (/ second 60.0 60.0 24.0)))))
413 (defun solar-ephemeris-time (time)
414 "Ephemeris Time at moment TIME.
415 TIME is a pair with the first component being the number of Julian centuries
416 elapsed at 0 Universal Time, and the second component counting Universal Time
417 hours. For instance, the pair corresponding to November 28, 1995 at 16 UT is
418 \(-0.040945 16), -0.040945 being the number of Julian centuries elapsed between
419 Jan 1, 2000 at 12 UT and November 28, 1995 at 0 UT.
421 Result is in Julian centuries of ephemeris time."
422 (let* ((t0 (car time))
423 (ut (cadr time))
424 (t1 (+ t0 (/ (/ ut 24.0) 36525)))
425 (y (+ 2000 (* 100 t1)))
426 (dt (* 86400 (solar-ephemeris-correction (floor y)))))
427 (+ t1 (/ (/ dt 86400) 36525))))
429 (defun solar-equatorial-coordinates (time sunrise-flag)
430 "Right ascension (in hours) and declination (in degrees) of the sun at TIME.
431 TIME is a pair with the first component being the number of
432 Julian centuries elapsed at 0 Universal Time, and the second
433 component counting Universal Time hours. For instance, the pair
434 corresponding to November 28, 1995 at 16 UT is (-0.040945 16),
435 -0.040945 being the number of Julian centuries elapsed between
436 Jan 1, 2000 at 12 UT and November 28, 1995 at 0 UT. SUNRISE-FLAG is passed
437 to `solar-ecliptic-coordinates'."
438 (let ((ec (solar-ecliptic-coordinates (solar-ephemeris-time time)
439 sunrise-flag)))
440 (list (solar-right-ascension (car ec) (cadr ec))
441 (solar-declination (car ec) (cadr ec)))))
443 (defun solar-horizontal-coordinates (time latitude longitude sunrise-flag)
444 "Azimuth and height of the sun at TIME, LATITUDE, and LONGITUDE.
445 TIME is a pair with the first component being the number of
446 Julian centuries elapsed at 0 Universal Time, and the second
447 component counting Universal Time hours. For instance, the pair
448 corresponding to November 28, 1995 at 16 UT is (-0.040945 16),
449 -0.040945 being the number of Julian centuries elapsed between
450 Jan 1, 2000 at 12 UT and November 28, 1995 at 0 UT. SUNRISE-FLAG
451 is passed to `solar-ecliptic-coordinates'. Azimuth and
452 height (between -180 and 180) are both in degrees."
453 (let* ((ut (cadr time))
454 (ec (solar-equatorial-coordinates time sunrise-flag))
455 (st (+ solar-sidereal-time-greenwich-midnight
456 (* ut 1.00273790935)))
457 ;; Hour angle (in degrees).
458 (ah (- (* st 15) (* 15 (car ec)) (* -1 longitude)))
459 (de (cadr ec))
460 (azimuth (solar-atn2 (- (* (solar-cosine-degrees ah)
461 (solar-sin-degrees latitude))
462 (* (solar-tangent-degrees de)
463 (solar-cosine-degrees latitude)))
464 (solar-sin-degrees ah)))
465 (height (solar-arcsin
466 (+ (* (solar-sin-degrees latitude) (solar-sin-degrees de))
467 (* (solar-cosine-degrees latitude)
468 (solar-cosine-degrees de)
469 (solar-cosine-degrees ah))))))
470 (if (> height 180) (setq height (- height 360)))
471 (list azimuth height)))
473 (defun solar-moment (direction latitude longitude time height)
474 "Sunrise/sunset at location.
475 Sunrise if DIRECTION =-1 or sunset if =1 at LATITUDE, LONGITUDE, with midday
476 being TIME.
478 TIME is a pair with the first component being the number of Julian centuries
479 elapsed at 0 Universal Time, and the second component counting Universal Time
480 hours. For instance, the pair corresponding to November 28, 1995 at 16 UT is
481 \(-0.040945 16), -0.040945 being the number of Julian centuries elapsed between
482 Jan 1, 2000 at 12 UT and November 28, 1995 at 0 UT.
484 HEIGHT is the angle the center of the sun has over the horizon for the contact
485 we are trying to find. For sunrise and sunset, it is usually -0.61 degrees,
486 accounting for the edge of the sun being on the horizon.
488 Uses binary search."
489 (let* ((ut (cadr time))
490 (possible t) ; we assume that rise or set are possible
491 (utmin (+ ut (* direction 12.0)))
492 (utmax ut) ; the time searched is between utmin and utmax
493 ;; utmin and utmax are in hours.
494 (utmoment-old 0.0) ; rise or set approximation
495 (utmoment 1.0) ; rise or set approximation
496 (hut 0) ; sun height at utmoment
497 (t0 (car time))
498 (hmin (cadr (solar-horizontal-coordinates (list t0 utmin)
499 latitude longitude t)))
500 (hmax (cadr (solar-horizontal-coordinates (list t0 utmax)
501 latitude longitude t))))
502 ;; -0.61 degrees is the height of the middle of the sun, when it
503 ;; rises or sets.
504 (if (< hmin height)
505 (if (> hmax height)
506 (while ;;; (< i 20) ; we perform a simple dichotomy
507 ;;; (> (abs (- hut height)) epsilon)
508 (>= (abs (- utmoment utmoment-old))
509 (/ solar-error 60))
510 (setq utmoment-old utmoment
511 utmoment (/ (+ utmin utmax) 2)
512 hut (cadr (solar-horizontal-coordinates
513 (list t0 utmoment) latitude longitude t)))
514 (if (< hut height) (setq utmin utmoment))
515 (if (> hut height) (setq utmax utmoment)))
516 (setq possible nil)) ; the sun never rises
517 (setq possible nil)) ; the sun never sets
518 (if possible utmoment)))
520 (defun solar-sunrise-and-sunset (time latitude longitude height)
521 "Sunrise, sunset and length of day.
522 Parameters are the midday TIME and the LATITUDE, LONGITUDE of the location.
524 TIME is a pair with the first component being the number of Julian centuries
525 elapsed at 0 Universal Time, and the second component counting Universal Time
526 hours. For instance, the pair corresponding to November 28, 1995 at 16 UT is
527 \(-0.040945 16), -0.040945 being the number of Julian centuries elapsed between
528 Jan 1, 2000 at 12 UT and November 28, 1995 at 0 UT.
530 HEIGHT is the angle the center of the sun has over the horizon for the contact
531 we are trying to find. For sunrise and sunset, it is usually -0.61 degrees,
532 accounting for the edge of the sun being on the horizon.
534 Coordinates are included because this function is called with latitude=1
535 degrees to find out if polar regions have 24 hours of sun or only night."
536 (let ((rise-time (solar-moment -1 latitude longitude time height))
537 (set-time (solar-moment 1 latitude longitude time height))
538 day-length)
539 (if (not (and rise-time set-time))
540 (if (or (and (> latitude 0)
541 solar-northern-spring-or-summer-season)
542 (and (< latitude 0)
543 (not solar-northern-spring-or-summer-season)))
544 (setq day-length 24)
545 (setq day-length 0))
546 (setq day-length (- set-time rise-time)))
547 (list (if rise-time (+ rise-time (/ calendar-time-zone 60.0)) nil)
548 (if set-time (+ set-time (/ calendar-time-zone 60.0)) nil)
549 day-length)))
551 (defun solar-time-string (time time-zone)
552 "Printable form for decimal fraction TIME in TIME-ZONE.
553 Format used is given by `calendar-time-display-form'."
554 (let* ((time (round (* 60 time)))
555 (24-hours (/ time 60)))
556 (calendar-dlet*
557 ((time-zone time-zone)
558 (minutes (format "%02d" (% time 60)))
559 (12-hours (format "%d" (1+ (% (+ 24-hours 11) 12))))
560 (am-pm (if (>= 24-hours 12) "pm" "am"))
561 (24-hours (format "%02d" 24-hours)))
562 (mapconcat #'eval calendar-time-display-form ""))))
564 (defun solar-daylight (time)
565 "Printable form for TIME expressed in hours."
566 (format "%d:%02d"
567 (floor time)
568 (floor (* 60 (- time (floor time))))))
570 (defun solar-julian-ut-centuries (date)
571 "Number of Julian centuries since 1 Jan, 2000 at noon UT for Gregorian DATE."
572 (/ (- (calendar-absolute-from-gregorian date)
573 (calendar-absolute-from-gregorian '(1 1.5 2000)))
574 36525.0))
576 (defun solar-date-to-et (date ut)
577 "Ephemeris Time at Gregorian DATE at Universal Time UT (in hours).
578 Expressed in Julian centuries of Ephemeris Time."
579 (solar-ephemeris-time (list (solar-julian-ut-centuries date) ut)))
581 (defun solar-time-equation (date ut)
582 "Equation of time expressed in hours at Gregorian DATE at Universal time UT."
583 (nth 2 (solar-ecliptic-coordinates (solar-date-to-et date ut) nil)))
585 (defun solar-exact-local-noon (date)
586 "Date and Universal Time of local noon at *local date* DATE.
587 The date may be different from the one asked for, but it will be the right
588 local date. The second component of date should be an integer."
589 (let* ((nd date)
590 (ut (- 12.0 (/ (calendar-longitude) 15)))
591 (te (solar-time-equation date ut)))
592 (setq ut (- ut te))
593 (if (>= ut 24)
594 (setq nd (list (car date) (1+ (cadr date))
595 (nth 2 date))
596 ut (- ut 24)))
597 (if (< ut 0)
598 (setq nd (list (car date) (1- (cadr date))
599 (nth 2 date))
600 ut (+ ut 24)))
601 (setq nd (calendar-gregorian-from-absolute ; date standardization
602 (calendar-absolute-from-gregorian nd)))
603 (list nd ut)))
605 (defun solar-sidereal-time (t0)
606 "Sidereal time (in hours) in Greenwich at T0 Julian centuries.
607 T0 must correspond to 0 hours UT."
608 (let* ((mean-sid-time (+ 6.6973746
609 (* 2400.051337 t0)
610 (* 0.0000258622 t0 t0)
611 (* -0.0000000017222 t0 t0 t0)))
612 (et (solar-ephemeris-time (list t0 0.0)))
613 (nut-i (solar-ecliptic-coordinates et nil))
614 (nut (nth 3 nut-i)) ; nutation
615 (i (cadr nut-i))) ; inclination
616 (mod (+ (mod (+ mean-sid-time
617 (/ (/ (* nut (solar-cosine-degrees i)) 15) 3600)) 24.0)
618 24.0)
619 24.0)))
621 (defun solar-sunrise-sunset (date)
622 "List of *local* times of sunrise, sunset, and daylight on Gregorian DATE.
623 Corresponding value is nil if there is no sunrise/sunset."
624 ;; First, get the exact moment of local noon.
625 (let* ((exact-local-noon (solar-exact-local-noon date))
626 ;; Get the time from the 2000 epoch.
627 (t0 (solar-julian-ut-centuries (car exact-local-noon)))
628 ;; Store the sidereal time at Greenwich at midnight of UT time.
629 ;; Find if summer or winter slightly above the equator.
630 (equator-rise-set
631 (progn (setq solar-sidereal-time-greenwich-midnight
632 (solar-sidereal-time t0))
633 (solar-sunrise-and-sunset
634 (list t0 (cadr exact-local-noon))
636 (calendar-longitude) 0)))
637 ;; Store the spring/summer information, compute sunrise and
638 ;; sunset (two first components of rise-set). Length of day
639 ;; is the third component (it is only the difference between
640 ;; sunset and sunrise when there is a sunset and a sunrise)
641 (rise-set
642 (progn
643 (setq solar-northern-spring-or-summer-season
644 (> (nth 2 equator-rise-set) 12))
645 (solar-sunrise-and-sunset
646 (list t0 (cadr exact-local-noon))
647 (calendar-latitude)
648 (calendar-longitude) -0.61)))
649 (rise-time (car rise-set))
650 (adj-rise (if rise-time (dst-adjust-time date rise-time)))
651 (set-time (cadr rise-set))
652 (adj-set (if set-time (dst-adjust-time date set-time)))
653 (length (nth 2 rise-set)))
654 (list
655 (and rise-time (calendar-date-equal date (car adj-rise)) (cdr adj-rise))
656 (and set-time (calendar-date-equal date (car adj-set)) (cdr adj-set))
657 (solar-daylight length))))
659 (defun solar-sunrise-sunset-string (date &optional nolocation)
660 "String of *local* times of sunrise, sunset, and daylight on Gregorian DATE.
661 Optional NOLOCATION non-nil means do not print the location."
662 (let ((l (solar-sunrise-sunset date)))
663 (format
664 "%s, %s%s (%s hrs daylight)"
665 (if (car l)
666 (concat "Sunrise " (apply #'solar-time-string (car l)))
667 "No sunrise")
668 (if (cadr l)
669 (concat "sunset " (apply #'solar-time-string (cadr l)))
670 "no sunset")
671 (if nolocation ""
672 (format " at %s" (eval calendar-location-name)))
673 (nth 2 l))))
675 (defconst solar-data-list
676 '((403406 4.721964 1.621043)
677 (195207 5.937458 62830.348067)
678 (119433 1.115589 62830.821524)
679 (112392 5.781616 62829.634302)
680 (3891 5.5474 125660.5691)
681 (2819 1.5120 125660.984)
682 (1721 4.1897 62832.4766)
683 (0 1.163 0.813)
684 (660 5.415 125659.31)
685 (350 4.315 57533.85)
686 (334 4.553 -33.931)
687 (314 5.198 777137.715)
688 (268 5.989 78604.191)
689 (242 2.911 5.412)
690 (234 1.423 39302.098)
691 (158 0.061 -34.861)
692 (132 2.317 115067.698)
693 (129 3.193 15774.337)
694 (114 2.828 5296.670)
695 (99 0.52 58849.27)
696 (93 4.65 5296.11)
697 (86 4.35 -3980.70)
698 (78 2.75 52237.69)
699 (72 4.50 55076.47)
700 (68 3.23 261.08)
701 (64 1.22 15773.85)
702 (46 0.14 188491.03)
703 (38 3.44 -7756.55)
704 (37 4.37 264.89)
705 (32 1.14 117906.27)
706 (29 2.84 55075.75)
707 (28 5.96 -7961.39)
708 (27 5.09 188489.81)
709 (27 1.72 2132.19)
710 (25 2.56 109771.03)
711 (24 1.92 54868.56)
712 (21 0.09 25443.93)
713 (21 5.98 -55731.43)
714 (20 4.03 60697.74)
715 (18 4.47 2132.79)
716 (17 0.79 109771.63)
717 (14 4.24 -7752.82)
718 (13 2.01 188491.91)
719 (13 2.65 207.81)
720 (13 4.98 29424.63)
721 (12 0.93 -7.99)
722 (10 2.21 46941.14)
723 (10 3.59 -68.29)
724 (10 1.50 21463.25)
725 (10 2.55 157208.40))
726 "Data used for calculation of solar longitude.")
728 (defun solar-longitude (d)
729 "Longitude of sun on astronomical (Julian) day number D.
730 Accuracy is about 0.0006 degree (about 365.25*24*60*0.0006/360 = 1 minutes).
731 The values of `calendar-daylight-savings-starts',
732 `calendar-daylight-savings-starts-time', `calendar-daylight-savings-ends',
733 `calendar-daylight-savings-ends-time', `calendar-daylight-time-offset', and
734 `calendar-time-zone' are used to interpret local time."
735 (let* ((a-d (calendar-astro-to-absolute d))
736 ;; Get Universal Time.
737 (date (calendar-astro-from-absolute
738 (- a-d
739 (if (dst-in-effect a-d)
740 (/ calendar-daylight-time-offset 24.0 60.0) 0)
741 (/ calendar-time-zone 60.0 24.0))))
742 ;; Get Ephemeris Time.
743 (date (+ date (solar-ephemeris-correction
744 (calendar-extract-year
745 (calendar-gregorian-from-absolute
746 (floor
747 (calendar-astro-to-absolute
748 date)))))))
749 (U (/ (- date 2451545) 3652500))
750 (longitude
751 (+ 4.9353929
752 (* 62833.1961680 U)
753 (* 0.0000001
754 (apply #'+
755 (mapcar (lambda (x)
756 (* (car x)
757 (sin (mod
758 (+ (cadr x)
759 (* (nth 2 x) U))
760 (* 2 float-pi)))))
761 solar-data-list)))))
762 (aberration
763 (* 0.0000001 (- (* 17 (cos (+ 3.10 (* 62830.14 U)))) 973)))
764 (A1 (mod (+ 2.18 (* U (+ -3375.70 (* 0.36 U)))) (* 2 float-pi)))
765 (A2 (mod (+ 3.51 (* U (+ 125666.39 (* 0.10 U)))) (* 2 float-pi)))
766 (nutation (* -0.0000001 (+ (* 834 (sin A1)) (* 64 (sin A2))))))
767 (mod (radians-to-degrees (+ longitude aberration nutation)) 360.0)))
769 (defun solar-date-next-longitude (d l)
770 "First time after day D when solar longitude is a multiple of L degrees.
771 D is a Julian day number. L must be an integer divisor of 360.
772 The result is for `calendar-location-name', and is in local time
773 \(including any daylight saving rules) expressed in astronomical (Julian)
774 day numbers. The values of `calendar-daylight-savings-starts',
775 `calendar-daylight-savings-starts-time', `calendar-daylight-savings-ends',
776 `calendar-daylight-savings-ends-time', `calendar-daylight-time-offset',
777 and `calendar-time-zone' are used to interpret local time."
778 (let ((start d)
779 (next (mod (* l (1+ (floor (/ (solar-longitude d) l)))) 360))
780 (end (+ d (* (/ l 360.0) 400)))
781 long)
782 ;; Bisection search for nearest minute.
783 (while (< 0.00001 (- end start))
784 ;; start <= d < end
785 ;; start-long <= next < end-long when next != 0
786 ;; when next = 0, look for the discontinuity (start-long is near 360
787 ;; and end-long is small (less than l)).
788 (setq d (/ (+ start end) 2.0)
789 long (solar-longitude d))
790 (if (or (and (not (zerop next)) (< long next))
791 (and (zerop next) (< l long)))
792 (setq start d)
793 (setq end d)))
794 (/ (+ start end) 2.0)))
796 ;; FIXME but there already is solar-sunrise-sunset.
797 ;;;###autoload
798 (defun sunrise-sunset (&optional arg)
799 "Local time of sunrise and sunset for today. Accurate to a few seconds.
800 If called with an optional prefix argument ARG, prompt for date.
801 If called with an optional double prefix argument, prompt for
802 longitude, latitude, time zone, and date, and always use standard time.
804 This function is suitable for execution in an init file."
805 (interactive "p")
806 (or arg (setq arg 1))
807 (if (and (< arg 16)
808 (not (and calendar-latitude calendar-longitude calendar-time-zone)))
809 (solar-setup))
810 (let* ((calendar-longitude
811 (if (< arg 16) calendar-longitude
812 (solar-get-number
813 "Enter longitude (decimal fraction; + east, - west): ")))
814 (calendar-latitude
815 (if (< arg 16) calendar-latitude
816 (solar-get-number
817 "Enter latitude (decimal fraction; + north, - south): ")))
818 (calendar-time-zone
819 (if (< arg 16) calendar-time-zone
820 (solar-get-number
821 "Enter difference from Coordinated Universal Time (in minutes): ")))
822 (calendar-location-name
823 (if (< arg 16) calendar-location-name
824 (let ((float-output-format "%.1f"))
825 (format "%s%s, %s%s"
826 (if (numberp calendar-latitude)
827 (abs calendar-latitude)
828 (+ (aref calendar-latitude 0)
829 (/ (aref calendar-latitude 1) 60.0)))
830 (if (numberp calendar-latitude)
831 (if (> calendar-latitude 0) "N" "S")
832 (if (eq (aref calendar-latitude 2) 'north) "N" "S"))
833 (if (numberp calendar-longitude)
834 (abs calendar-longitude)
835 (+ (aref calendar-longitude 0)
836 (/ (aref calendar-longitude 1) 60.0)))
837 (if (numberp calendar-longitude)
838 (if (> calendar-longitude 0) "E" "W")
839 (if (eq (aref calendar-longitude 2) 'east)
840 "E" "W"))))))
841 (calendar-standard-time-zone-name
842 (if (< arg 16) calendar-standard-time-zone-name
843 (cond ((zerop calendar-time-zone) "UTC")
844 ((< calendar-time-zone 0)
845 (format "UTC%dmin" calendar-time-zone))
846 (t (format "UTC+%dmin" calendar-time-zone)))))
847 (calendar-daylight-savings-starts
848 (if (< arg 16) calendar-daylight-savings-starts))
849 (calendar-daylight-savings-ends
850 (if (< arg 16) calendar-daylight-savings-ends))
851 (date (if (< arg 4) (calendar-current-date) (calendar-read-date)))
852 (date-string (calendar-date-string date t))
853 (time-string (solar-sunrise-sunset-string date))
854 (msg (format "%s%s"
855 (if (< arg 4) "" ; don't print date if it's today's
856 (format "%s: " date-string))
857 time-string)))
858 (message "%s" msg)
859 msg))
861 ;;;###cal-autoload
862 (defun calendar-sunrise-sunset (&optional event)
863 "Local time of sunrise and sunset for date under cursor.
864 Accurate to a few seconds."
865 (interactive (list last-nonmenu-event))
866 (or (and calendar-latitude calendar-longitude calendar-time-zone)
867 (solar-setup))
868 (let ((date (calendar-cursor-to-date t event)))
869 (message "%s: %s"
870 (calendar-date-string date t t)
871 (solar-sunrise-sunset-string date))))
873 ;;;###cal-autoload
874 (defun calendar-sunrise-sunset-month (&optional event)
875 "Local time of sunrise and sunset for month under cursor or at EVENT."
876 (interactive (list last-nonmenu-event))
877 (or (and calendar-latitude calendar-longitude calendar-time-zone)
878 (solar-setup))
879 (let* ((date (calendar-cursor-to-date t event))
880 (month (car date))
881 (year (nth 2 date))
882 (last (calendar-last-day-of-month month year))
883 (title (format "Sunrise/sunset times for %s %d at %s"
884 (calendar-month-name month) year
885 (eval calendar-location-name))))
886 (calendar-in-read-only-buffer solar-sunrises-buffer
887 (calendar-set-mode-line title)
888 (insert title ":\n\n")
889 (dotimes (i last)
890 (setq date (list month (1+ i) year))
891 (insert (format "%s %2d: " (calendar-month-name month t) (1+ i))
892 (solar-sunrise-sunset-string date t) "\n")))))
894 ;;;###diary-autoload
895 (defun diary-sunrise-sunset ()
896 "Local time of sunrise and sunset as a diary entry.
897 Accurate to a few seconds."
898 ;; To be called from diary-list-sexp-entries, where DATE is bound.
899 (with-no-warnings (defvar date))
900 (or (and calendar-latitude calendar-longitude calendar-time-zone)
901 (solar-setup))
902 (solar-sunrise-sunset-string date))
904 ;; From Meeus, 1991, page 167.
905 (defconst solar-seasons-data
906 '((485 324.96 1934.136)
907 (203 337.23 32964.467)
908 (199 342.08 20.186)
909 (182 27.85 445267.112)
910 (156 73.14 45036.886)
911 (136 171.52 22518.443)
912 (77 222.54 65928.934)
913 (74 296.72 3034.906)
914 (70 243.58 9037.513)
915 (58 119.81 33718.147)
916 (52 297.17 150.678)
917 (50 21.02 2281.226)
918 (45 247.54 29929.562)
919 (44 325.15 31555.956)
920 (29 60.93 4443.417)
921 (18 155.12 67555.328)
922 (17 288.79 4562.452)
923 (16 198.04 62894.029)
924 (14 199.76 31436.921)
925 (12 95.39 14577.848)
926 (12 287.11 31931.756)
927 (12 320.81 34777.259)
928 (9 227.73 1222.114)
929 (8 15.45 16859.074))
930 "Data for solar equinox/solstice calculations.")
932 (defun solar-equinoxes/solstices (k year)
933 "Date of equinox/solstice K for YEAR.
934 K=0, spring equinox; K=1, summer solstice; K=2, fall equinox;
935 K=3, winter solstice. RESULT is a Gregorian local date.
936 Accurate to within a minute between 1951 and 2050."
937 (let* ((JDE0 (solar-mean-equinoxes/solstices k year))
938 (T (/ (- JDE0 2451545.0) 36525))
939 (W (- (* 35999.373 T) 2.47))
940 (Delta-lambda (+ 1 (* 0.0334 (solar-cosine-degrees W))
941 (* 0.0007 (solar-cosine-degrees (* 2 W)))))
942 (S (apply #'+ (mapcar (lambda(x)
943 (* (car x) (solar-cosine-degrees
944 (+ (* (nth 2 x) T) (cadr x)))))
945 solar-seasons-data)))
946 (JDE (+ JDE0 (/ (* 0.00001 S) Delta-lambda)))
947 ;; Ephemeris time correction.
948 (correction (+ 102.3 (* 123.5 T) (* 32.5 T T)))
949 (JD (- JDE (/ correction 86400)))
950 (date (calendar-gregorian-from-absolute (floor (- JD 1721424.5))))
951 (time (- (- JD 0.5) (floor (- JD 0.5)))))
952 (list (car date) (+ (cadr date) time
953 (/ (/ calendar-time-zone 60.0) 24.0))
954 (nth 2 date))))
956 ;; From Meeus, 1991, page 166.
957 (defun solar-mean-equinoxes/solstices (k year)
958 "Julian day of mean equinox/solstice K for YEAR.
959 K=0, spring equinox; K=1, summer solstice; K=2, fall equinox; K=3, winter
960 solstice. These formulas are only to be used between 1000 BC and 3000 AD."
961 (let ((y (/ year 1000.0))
962 (z (/ (- year 2000) 1000.0)))
963 (if (< year 1000) ; actually between -1000 and 1000
964 (cond ((= k 0) (+ 1721139.29189
965 (* 365242.13740 y)
966 (* 0.06134 y y)
967 (* 0.00111 y y y)
968 (* -0.00071 y y y y)))
969 ((= k 1) (+ 1721233.25401
970 (* 365241.72562 y)
971 (* -0.05323 y y)
972 (* 0.00907 y y y)
973 (* 0.00025 y y y y)))
974 ((= k 2) (+ 1721325.70455
975 (* 365242.49558 y)
976 (* -0.11677 y y)
977 (* -0.00297 y y y)
978 (* 0.00074 y y y y)))
979 ((= k 3) (+ 1721414.39987
980 (* 365242.88257 y)
981 (* -0.00769 y y)
982 (* -0.00933 y y y)
983 (* -0.00006 y y y y))))
984 ; actually between 1000 and 3000
985 (cond ((= k 0) (+ 2451623.80984
986 (* 365242.37404 z)
987 (* 0.05169 z z)
988 (* -0.00411 z z z)
989 (* -0.00057 z z z z)))
990 ((= k 1) (+ 2451716.56767
991 (* 365241.62603 z)
992 (* 0.00325 z z)
993 (* 0.00888 z z z)
994 (* -0.00030 z z z z)))
995 ((= k 2) (+ 2451810.21715
996 (* 365242.01767 z)
997 (* -0.11575 z z)
998 (* 0.00337 z z z)
999 (* 0.00078 z z z z)))
1000 ((= k 3) (+ 2451900.05952
1001 (* 365242.74049 z)
1002 (* -0.06223 z z)
1003 (* -0.00823 z z z)
1004 (* 0.00032 z z z z)))))))
1006 (defvar displayed-month) ; from calendar-generate
1007 (defvar displayed-year)
1009 ;;;###holiday-autoload
1010 (defun solar-equinoxes-solstices ()
1011 "Local date and time of equinoxes and solstices, if visible in the calendar.
1012 Requires floating point."
1013 (let* ((m displayed-month)
1014 (y displayed-year)
1015 (calendar-standard-time-zone-name
1016 (if calendar-time-zone calendar-standard-time-zone-name "UTC"))
1017 (calendar-daylight-savings-starts
1018 (if calendar-time-zone calendar-daylight-savings-starts))
1019 (calendar-daylight-savings-ends
1020 (if calendar-time-zone calendar-daylight-savings-ends))
1021 (calendar-time-zone (if calendar-time-zone calendar-time-zone 0))
1022 (k (progn
1023 (calendar-increment-month m y (cond ((= 1 (% m 3)) -1)
1024 ((= 2 (% m 3)) 1)
1025 (t 0)))
1026 (1- (/ m 3))))
1027 (d0 (solar-equinoxes/solstices k y))
1028 (d1 (list (car d0) (floor (cadr d0)) (nth 2 d0)))
1029 (h0 (* 24 (- (cadr d0) (floor (cadr d0)))))
1030 (adj (dst-adjust-time d1 h0))
1031 (d (list (caar adj)
1032 (+ (car (cdar adj))
1033 (/ (cadr adj) 24.0))
1034 (cadr (cdar adj))))
1035 ;; The following is nearly as accurate, but not quite:
1036 ;; (d0 (solar-date-next-longitude
1037 ;; (calendar-astro-from-absolute
1038 ;; (calendar-absolute-from-gregorian
1039 ;; (list (+ 3 (* k 3)) 15 y)))
1040 ;; 90))
1041 ;; (abs-day (calendar-astro-to-absolute d)))
1042 (abs-day (calendar-absolute-from-gregorian d)))
1043 (list
1044 (list (calendar-gregorian-from-absolute (floor abs-day))
1045 (format "%s %s"
1046 (nth k (if (and calendar-latitude
1047 (< (calendar-latitude) 0))
1048 solar-s-hemi-seasons
1049 solar-n-hemi-seasons))
1050 (solar-time-string
1051 (* 24 (- abs-day (floor abs-day)))
1052 (if (dst-in-effect abs-day)
1053 calendar-daylight-time-zone-name
1054 calendar-standard-time-zone-name)))))))
1057 (provide 'solar)
1059 ;;; solar.el ends here