entered into RCS
[bpt/emacs.git] / lisp / calendar / lunar.el
CommitLineData
7e1dae73
JB
1;;; lunar.el --- calendar functions for phases of the moon.
2
3;; Copyright (C) 1992 Free Software Foundation, Inc.
4
5;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
6;; Keywords: moon, lunar phases, calendar, diary
7
8;; This file is part of GNU Emacs.
9
10;; GNU Emacs is distributed in the hope that it will be useful,
11;; but WITHOUT ANY WARRANTY. No author or distributor
12;; accepts responsibility to anyone for the consequences of using it
13;; or for whether it serves any particular purpose or works at all,
14;; unless he says so in writing. Refer to the GNU Emacs General Public
15;; License for full details.
16
17;; Everyone is granted permission to copy, modify and redistribute
18;; GNU Emacs, but only under the conditions described in the
19;; GNU Emacs General Public License. A copy of this license is
20;; supposed to have been given to you along with GNU Emacs so you
21;; can know your rights and responsibilities. It should be in a
22;; file named COPYING. Among other things, the copyright notice
23;; and this notice must be preserved on all copies.
24
25;;; Commentary:
26
27;; This collection of functions implements lunar phases for calendar.el and
28;; diary.el.
29
30;; Based on ``Astronomical Formulae for Calculators,'' 3rd ed., by Jean Meeus,
31;; Willmann-Bell, Inc., 1985.
32;;
33;; WARNING: The calculations will be accurate only to within a few minutes.
34
35;; The author would be delighted to have an astronomically more sophisticated
36;; person rewrite the code for the lunar calculations in this file!
37
38;; Comments, corrections, and improvements should be sent to
39;; Edward M. Reingold Department of Computer Science
40;; (217) 333-6733 University of Illinois at Urbana-Champaign
41;; reingold@cs.uiuc.edu 1304 West Springfield Avenue
42;; Urbana, Illinois 61801
43
44;;; Code:
45
46(if (fboundp 'atan)
47 (require 'lisp-float-type)
48 (error "Lunar calculations impossible since floating point is unavailable."))
49
50(require 'solar)
51
52(defun lunar-phase-list (month year)
53 "List of lunar phases for three months starting with Gregorian MONTH, YEAR."
54 (let ((end-month month)
55 (end-year year)
56 (start-month month)
57 (start-year year))
58 (increment-calendar-month end-month end-year 3)
59 (increment-calendar-month start-month start-year -1)
60 (let* ((end-date (list (list end-month 1 end-year)))
61 (start-date (list (list start-month
62 (calendar-last-day-of-month
63 start-month start-year)
64 start-year)))
65 (index (* 4
66 (truncate
67 (* 12.3685
68 (+ year
69 ( / (calendar-day-number (list month 1 year))
70 366.0)
71 -1900)))))
72 (new-moon (lunar-phase index))
73 (list))
74 (while (calendar-date-compare new-moon end-date)
75 (if (calendar-date-compare start-date new-moon)
76 (setq list (append list (list new-moon))))
77 (setq index (1+ index))
78 (setq new-moon (lunar-phase index)))
79 list)))
80
81(defun lunar-phase (index)
82 "Local date and time of lunar phase INDEX.
83Integer below INDEX/4 gives the lunation number, counting from Jan 1, 1900;
84remainder mod 4 gives the phase: 0 new moon, 1 first quarter, 2 full moon,
853 last quarter."
86 (let* ((phase (% index 4))
87 (index (/ index 4.0))
88 (time (/ index 1236.85))
89 (date (+ (calendar-absolute-from-gregorian '(1 0.5 1900))
90 0.75933
91 (* 29.53058868 index)
92 (* 0.0001178 time time)
93 (* -0.000000155 time time time)
94 (* 0.00033
95 (solar-sin-degrees (+ 166.56
96 (* 132.87 time)
97 (* -0.009173 time time))))))
98 (sun-anomaly (solar-mod
99 (+ 359.2242
100 (* 29.105356 index)
101 (* -0.0000333 time time)
102 (* -0.00000347 time time time))
103 360.0))
104 (moon-anomaly (solar-mod
105 (+ 306.0253
106 (* 385.81691806 index)
107 (* 0.0107306 time time)
108 (* 0.00001236 time time time))
109 360.0))
110 (moon-lat (solar-mod
111 (+ 21.2964
112 (* 390.67050646 index)
113 (* -0.0016528 time time)
114 (* -0.00000239 time time time))
115 360.0))
116 (adjustment
117 (if (memq phase '(0 2))
118 (+ (* (- 0.1734 (* 0.000393 time))
119 (solar-sin-degrees sun-anomaly))
120 (* 0.0021 (solar-sin-degrees (* 2 sun-anomaly)))
121 (* -0.4068 (solar-sin-degrees moon-anomaly))
122 (* 0.0161 (solar-sin-degrees (* 2 moon-anomaly)))
123 (* -0.0004 (solar-sin-degrees (* 3 moon-anomaly)))
124 (* 0.0104 (solar-sin-degrees (* 2 moon-lat)))
125 (* -0.0051 (solar-sin-degrees (+ sun-anomaly moon-anomaly)))
126 (* -0.0074 (solar-sin-degrees (- sun-anomaly moon-anomaly)))
127 (* 0.0004 (solar-sin-degrees (+ (* 2 moon-lat) sun-anomaly)))
128 (* -0.0004 (solar-sin-degrees (- (* 2 moon-lat) sun-anomaly)))
129 (* -0.0006 (solar-sin-degrees
130 (+ (* 2 moon-lat) moon-anomaly)))
131 (* 0.0010 (solar-sin-degrees (- (* 2 moon-lat) moon-anomaly)))
132 (* 0.0005 (solar-sin-degrees
133 (+ (* 2 moon-anomaly) sun-anomaly))))
134 (+ (* (- 0.1721 (* 0.0004 time))
135 (solar-sin-degrees sun-anomaly))
136 (* 0.0021 (solar-sin-degrees (* 2 sun-anomaly)))
137 (* -0.6280 (solar-sin-degrees moon-anomaly))
138 (* 0.0089 (solar-sin-degrees (* 2 moon-anomaly)))
139 (* -0.0004 (solar-sin-degrees (* 3 moon-anomaly)))
140 (* 0.0079 (solar-sin-degrees (* 2 moon-lat)))
141 (* -0.0119 (solar-sin-degrees (+ sun-anomaly moon-anomaly)))
142 (* -0.0047 (solar-sin-degrees (- sun-anomaly moon-anomaly)))
143 (* 0.0003 (solar-sin-degrees (+ (* 2 moon-lat) sun-anomaly)))
144 (* -0.0004 (solar-sin-degrees (- (* 2 moon-lat) sun-anomaly)))
145 (* -0.0006 (solar-sin-degrees (+ (* 2 moon-lat) moon-anomaly)))
146 (* 0.0021 (solar-sin-degrees (- (* 2 moon-lat) moon-anomaly)))
147 (* 0.0003 (solar-sin-degrees
148 (+ (* 2 moon-anomaly) sun-anomaly)))
149 (* 0.0004 (solar-sin-degrees
150 (- sun-anomaly (* 2 moon-anomaly))))
151 (* -0.0003 (solar-sin-degrees
152 (+ (* 2 sun-anomaly) moon-anomaly))))))
153 (adj (+ 0.0028
154 (* -0.0004 (solar-cosine-degrees
155 sun-anomaly))
156 (* 0.0003 (solar-cosine-degrees
157 moon-anomaly))))
158 (adjustment (cond ((= phase 1) (+ adjustment adj))
159 ((= phase 2) (- adjustment adj))
160 (t adjustment)))
161 (date (+ date adjustment))
162 (calendar-standard-time-zone-name
163 (if calendar-time-zone calendar-standard-time-zone-name "UT"))
164 (calendar-daylight-savings-starts
165 (if calendar-time-zone calendar-daylight-savings-starts))
166 (calendar-daylight-savings-ends
167 (if calendar-time-zone calendar-daylight-savings-ends))
168 (calendar-time-zone (if calendar-time-zone calendar-time-zone 0))
169 (year (extract-calendar-year
170 (calendar-gregorian-from-absolute (truncate date))))
171 (dst (and calendar-daylight-savings-starts
172 calendar-daylight-savings-ends
173 (<= (calendar-absolute-from-gregorian
174 (eval calendar-daylight-savings-starts))
175 date)
176 (< date
177 (calendar-absolute-from-gregorian
178 (eval calendar-daylight-savings-ends)))))
179 (date (+ date
180 (/ (+ (if dst 60 0) calendar-time-zone) 60.0 24.0)
181 (- (/ (solar-ephemeris-correction year) 60.0 24.0))))
182 (time (* 24 (- date (truncate date))))
183 (date (calendar-gregorian-from-absolute (truncate date)))
184 (time-zone calendar-time-zone)
185 (time-zone (if dst
186 calendar-daylight-time-zone-name
187 calendar-standard-time-zone-name))
188 (24-hours (truncate time))
189 (12-hours (format "%d" (if (> 24-hours 12)
190 (- 24-hours 12)
191 (if (= 24-hours 0) 12 24-hours))))
192 (am-pm (if (>= 24-hours 12) "pm" "am"))
193 (minutes (format "%02d" (round (* 60 (- time 24-hours)))))
194 (24-hours (format "%02d" 24-hours))
195 (time (mapconcat 'eval calendar-time-display-form "")))
196 (list date time phase)))
197
198(defun lunar-phase-name (phase)
199 "Name of lunar PHASE.
2000 = new moon, 1 = first quarter, 2 = full moon, 3 = last quarter."
201 (cond ((= 0 phase) "New Moon")
202 ((= 1 phase) "First Quarter Moon")
203 ((= 2 phase) "Full Moon")
204 ((= 3 phase) "Last Quarter Moon")))
205
206(defun calendar-phases-of-moon ()
207 "Create a buffer with the lunar phases for the current calendar window."
208 (interactive)
209 (message "Computing phases of the moon...")
210 (let ((m1 displayed-month)
211 (y1 displayed-year)
212 (m2 displayed-month)
213 (y2 displayed-year)
214 (lunar-phases-buffer "*Phases of Moon*"))
215 (increment-calendar-month m1 y1 -1)
216 (increment-calendar-month m2 y2 1)
217 (set-buffer (get-buffer-create lunar-phases-buffer))
218 (setq buffer-read-only nil)
219 (calendar-set-mode-line
220 (format "Phases of the moon from %s, %d to %s, %d%%-"
221 (calendar-month-name m1) y1 (calendar-month-name m2) y2))
222 (erase-buffer)
223 (insert
224 (mapconcat
225 '(lambda (x)
226 (let ((date (car x))
227 (time (car (cdr x)))
228 (phase (car (cdr (cdr x)))))
229 (concat (calendar-date-string date)
230 ": "
231 (lunar-phase-name phase)
232 " "
233 time)))
234 (lunar-phase-list m1 y1) "\n"))
235 (goto-char (point-min))
236 (set-buffer-modified-p nil)
237 (setq buffer-read-only t)
238 (display-buffer lunar-phases-buffer)
239 (message "Computing phases of the moon...done")))
240
241;;;###autoload
242(defun phases-of-moon (&optional arg)
243 "Display the quarters of the moon for last month, this month, and next month.
244If called with an optional prefix argument, prompts for month and year.
245
246This function is suitable for execution in a .emacs file."
247 (interactive "P")
248 (save-excursion
249 (let* ((completion-ignore-case t)
250 (date (calendar-current-date))
251 (displayed-month
252 (if arg
253 (cdr (assoc
254 (capitalize
255 (completing-read
256 "Month name: "
257 (mapcar 'list (append calendar-month-name-array nil))
258 nil t))
259 (calendar-make-alist calendar-month-name-array)))
260 (extract-calendar-month date)))
261 (displayed-year
262 (if arg
263 (calendar-read
264 "Year (>0): "
265 '(lambda (x) (> x 0))
266 (int-to-string
267 (extract-calendar-year (calendar-current-date))))
268 (extract-calendar-year date))))
269 (calendar-phases-of-moon))))
270
271(defun diary-phases-of-moon ()
272 "Moon phases diary entry."
273 (let* ((index (* 4
274 (truncate
275 (* 12.3685
276 (+ (extract-calendar-year date)
277 ( / (calendar-day-number date)
278 366.0)
279 -1900)))))
280 (phase (lunar-phase index)))
281 (while (calendar-date-compare phase (list date))
282 (setq index (1+ index))
283 (setq phase (lunar-phase index)))
284 (if (calendar-date-equal (car phase) date)
285 (concat (lunar-phase-name (car (cdr (cdr phase)))) " "
286 (car (cdr phase))))))
287
288(provide 'lunar)
289
290;;; lunar.el ends here