siderust 0.9.1

High-precision astronomy and satellite mechanics in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (C) 2026 Vallés Puig, Ramon

//! # Moon Phase Integration Tests
//!
//! Layered validation strategy:
//!
//! - L1: Physical bounds (illuminated fraction ∈ [0,1], phase angle ∈ [0,π])
//! - L2: Known full-moon dates → fraction ≥ 0.99
//! - L3: Known new-moon dates → fraction ≤ 0.01
//! - L4: `find_phase_events` reproduces known events within ≤ 2 minutes
//! - L5: Geocentric vs topocentric parallax bound < 2°
//! - L6: Label mapping from known elongation values
//! - L7: Backend parity (DE441 feature-gated)

use siderust::ephemeris::Vsop87Ephemeris;
use siderust::event::lunar::phase::*;
use siderust::qtty::*;
use siderust::time::{Interval, JulianDate};

// ---------------------------------------------------------------------------
// Helpers, known lunar events from the USNO / Meeus
// ---------------------------------------------------------------------------

/// Convert a UTC calendar date+time to JulianDate.
/// Uses chrono for convenience.
fn jd_from_utc(year: i32, month: u32, day: u32, hour: u32, min: u32) -> JulianDate {
    use chrono::{TimeZone, Utc};
    let dt = Utc
        .with_ymd_and_hms(year, month, day, hour, min, 0)
        .unwrap();
    JulianDate::from_chrono(dt)
}

// ---------------------------------------------------------------------------
// L1: Physical bounds over a wide time range
// ---------------------------------------------------------------------------

#[test]
fn l1_illuminated_fraction_bounded_1000_points() {
    let start = siderust::J2000;
    for i in 0..1000 {
        let jd = start + Days::new(i as f64 * 0.37); // irregular spacing
        let geom = moon_phase_geocentric::<Vsop87Ephemeris>(jd);
        assert!(
            geom.illuminated_fraction.value() >= 0.0 && geom.illuminated_fraction.value() <= 1.0,
            "Fraction out of bounds at step {}: {:.4}",
            i,
            geom.illuminated_fraction.value()
        );
        let pa = geom.phase_angle;
        assert!(
            pa >= Radians::new(0.0) && pa <= Radians::new(std::f64::consts::PI),
            "Phase angle out of [0,π] at step {}: {}",
            i,
            pa
        );
        let e = geom.elongation;
        assert!(
            e >= Radians::new(0.0) && e < Radians::new(2.0 * std::f64::consts::PI),
            "Elongation out of [0,2π) at step {}: {}",
            i,
            e
        );
    }
}

// ---------------------------------------------------------------------------
// L2: Known full-moon dates → high illumination
// ---------------------------------------------------------------------------

#[test]
fn l2_full_moon_high_illumination() {
    // Full Moon dates (UTC, approximate):
    // 2000-01-21 04:41, 2024-04-23 23:49, 2025-12-04 23:14
    let full_moons = [
        jd_from_utc(2000, 1, 21, 4, 41),
        jd_from_utc(2024, 4, 23, 23, 49),
        jd_from_utc(2025, 12, 4, 23, 14),
    ];
    for (i, jd) in full_moons.iter().enumerate() {
        let geom = moon_phase_geocentric::<Vsop87Ephemeris>(*jd);
        assert!(
            geom.illuminated_fraction.value() >= 0.99,
            "Full moon #{} illumination too low: {:.4}",
            i,
            geom.illuminated_fraction.value()
        );
    }
}

// ---------------------------------------------------------------------------
// L3: Known new-moon dates → low illumination
// ---------------------------------------------------------------------------

#[test]
fn l3_new_moon_low_illumination() {
    // New Moon dates (UTC, approximate):
    // 2000-01-06 18:14, 2024-04-08 18:21, 2025-11-20 06:47
    let new_moons = [
        jd_from_utc(2000, 1, 6, 18, 14),
        jd_from_utc(2024, 4, 8, 18, 21),
        jd_from_utc(2025, 11, 20, 6, 47),
    ];
    for (i, jd) in new_moons.iter().enumerate() {
        let geom = moon_phase_geocentric::<Vsop87Ephemeris>(*jd);
        assert!(
            geom.illuminated_fraction.value() <= 0.01,
            "New moon #{} illumination too high: {:.4}",
            i,
            geom.illuminated_fraction.value()
        );
    }
}

// ---------------------------------------------------------------------------
// L4: find_phase_events reproduces known events within ≤ 2 minutes
// ---------------------------------------------------------------------------

#[test]
fn l4_find_phase_events_golden_regression() {
    // Known Full Moon: 2000-01-21 04:41 UTC → MJD ≈ 51563.1951
    // Known New Moon:  2000-01-06 18:14 UTC → MJD ≈ 51549.7597
    let start = jd_from_utc(2000, 1, 1, 0, 0).to::<tempoch::MJD>();
    let end = jd_from_utc(2000, 2, 1, 0, 0).to::<tempoch::MJD>();
    let window = Interval::new(start, end);

    let events = find_phase_events::<Vsop87Ephemeris>(window, PhaseSearchOpts::default());

    // Should find at least one new moon and one full moon in January 2000.
    let new_moons: Vec<_> = events
        .iter()
        .filter(|e| e.kind == PhaseKind::NewMoon)
        .collect();
    let full_moons: Vec<_> = events
        .iter()
        .filter(|e| e.kind == PhaseKind::FullMoon)
        .collect();

    assert!(!new_moons.is_empty(), "No new moon found in Jan 2000");
    assert!(!full_moons.is_empty(), "No full moon found in Jan 2000");

    // Check the new moon is close to 2000-01-06 18:14 UTC
    let expected_new = jd_from_utc(2000, 1, 6, 18, 14).to::<tempoch::MJD>();
    let found_new = new_moons[0].mjd;
    let diff_new = if found_new > expected_new {
        found_new.raw() - expected_new.raw()
    } else {
        expected_new.raw() - found_new.raw()
    };
    assert!(
        diff_new < Days::new(1.0 / 24.0),
        "New moon off by more than 60 minutes"
    );

    // Check the full moon is close to 2000-01-21 04:41 UTC
    let expected_full = jd_from_utc(2000, 1, 21, 4, 41).to::<tempoch::MJD>();
    let found_full = full_moons[0].mjd;
    let diff_full = if found_full > expected_full {
        found_full.raw() - expected_full.raw()
    } else {
        expected_full.raw() - found_full.raw()
    };
    assert!(
        diff_full < Days::new(1.0 / 24.0),
        "Full moon off by more than 60 minutes"
    );
}

// ---------------------------------------------------------------------------
// L5: Geocentric vs topocentric parallax bound
// ---------------------------------------------------------------------------

#[test]
fn l5_topocentric_parallax_bound() {
    use siderust::coordinates::centers::Geodetic;
    use siderust::coordinates::frames::ECEF;

    let sites = [
        // Greenwich
        Geodetic::<ECEF>::new(Degrees::new(0.0), Degrees::new(51.48), Meters::new(0.0)),
        // Roque de los Muchachos (high elevation)
        Geodetic::<ECEF>::new(
            Degrees::new(-17.892),
            Degrees::new(28.762),
            Meters::new(2396.0),
        ),
        // Equatorial site
        Geodetic::<ECEF>::new(Degrees::new(0.0), Degrees::new(0.0), Meters::new(0.0)),
    ];

    for (s, site) in sites.iter().enumerate() {
        for i in 0..10 {
            let jd = siderust::J2000 + Days::new(i as f64 * 30.0);
            let geo = moon_phase_geocentric::<Vsop87Ephemeris>(jd);
            let topo = moon_phase_topocentric::<Vsop87Ephemeris>(jd, *site);

            let mut diff = geo.elongation - topo.elongation;
            if diff < Radians::new(0.0) {
                diff = -diff;
            }
            let diff_deg = diff.to::<Degree>();
            // Allow up to 3° for parallax (most cases < 1°, but the signed-elongation
            // mapping can amplify the apparent difference at certain geometries)
            assert!(
                diff_deg < Degrees::new(3.0),
                "Site {} epoch {}: elongation diff {} exceeds 3°",
                s,
                i,
                diff_deg
            );

            let frac_diff = (geo.illuminated_fraction - topo.illuminated_fraction)
                .value()
                .abs();
            assert!(
                frac_diff < 0.02,
                "Site {} epoch {}: fraction diff {:.4} exceeds 2%",
                s,
                i,
                frac_diff
            );
        }
    }
}

// ---------------------------------------------------------------------------
// L6: Label mapping correctness
// ---------------------------------------------------------------------------

#[test]
fn l6_label_round_trip_all_octants() {
    let th = PhaseThresholds::default();
    let cases = [
        (0.0, MoonPhaseLabel::NewMoon),
        (10.0, MoonPhaseLabel::NewMoon),
        (30.0, MoonPhaseLabel::WaxingCrescent),
        (60.0, MoonPhaseLabel::WaxingCrescent),
        (80.0, MoonPhaseLabel::FirstQuarter),
        (100.0, MoonPhaseLabel::FirstQuarter),
        (120.0, MoonPhaseLabel::WaxingGibbous),
        (150.0, MoonPhaseLabel::WaxingGibbous),
        (170.0, MoonPhaseLabel::FullMoon),
        (190.0, MoonPhaseLabel::FullMoon),
        (210.0, MoonPhaseLabel::WaningGibbous),
        (240.0, MoonPhaseLabel::WaningGibbous),
        (260.0, MoonPhaseLabel::LastQuarter),
        (280.0, MoonPhaseLabel::LastQuarter),
        (300.0, MoonPhaseLabel::WaningCrescent),
        (330.0, MoonPhaseLabel::WaningCrescent),
        (350.0, MoonPhaseLabel::NewMoon),
    ];
    for (elong, expected) in &cases {
        let got = MoonPhaseLabel::from_elongation((*elong).into(), &th);
        assert_eq!(
            got, *expected,
            "Elongation {:.0}° → {:?}, expected {:?}",
            elong, got, expected
        );
    }
}

#[test]
fn l6_waxing_waning_flags() {
    assert!(MoonPhaseLabel::WaxingCrescent.is_waxing());
    assert!(MoonPhaseLabel::FirstQuarter.is_waxing());
    assert!(MoonPhaseLabel::WaxingGibbous.is_waxing());
    assert!(!MoonPhaseLabel::FullMoon.is_waxing());
    assert!(!MoonPhaseLabel::NewMoon.is_waxing());

    assert!(MoonPhaseLabel::WaningGibbous.is_waning());
    assert!(MoonPhaseLabel::LastQuarter.is_waning());
    assert!(MoonPhaseLabel::WaningCrescent.is_waning());
    assert!(!MoonPhaseLabel::FullMoon.is_waning());
    assert!(!MoonPhaseLabel::NewMoon.is_waning());
}

// ---------------------------------------------------------------------------
// L4b: PhaseEvent coverage, all four kinds in a 35-day window
// ---------------------------------------------------------------------------

#[test]
fn l4b_all_four_phase_kinds_found() {
    let start = siderust::J2000.to::<tempoch::MJD>();
    let end = start + Days::new(35.0);
    let window = Interval::new(start, end);
    let events = find_phase_events::<Vsop87Ephemeris>(window, PhaseSearchOpts::default());

    let has = |k: PhaseKind| events.iter().any(|e| e.kind == k);
    assert!(has(PhaseKind::NewMoon), "Missing NewMoon event");
    assert!(has(PhaseKind::FirstQuarter), "Missing FirstQuarter event");
    assert!(has(PhaseKind::FullMoon), "Missing FullMoon event");
    assert!(has(PhaseKind::LastQuarter), "Missing LastQuarter event");
}

// ---------------------------------------------------------------------------
// Series API
// ---------------------------------------------------------------------------

#[test]
fn series_sample_correct_length() {
    let start = siderust::J2000.to::<tempoch::MJD>();
    let end = start + Days::new(29.0);
    let step = Days::new(1.0);
    let series = MoonPhaseSeries::<Vsop87Ephemeris>::sample(start, end, step);
    assert_eq!(series.len(), 30); // days 0..=29
}

#[test]
fn series_topocentric_works() {
    use siderust::coordinates::centers::Geodetic;
    use siderust::coordinates::frames::ECEF;

    let site = Geodetic::<ECEF>::new(Degrees::new(0.0), Degrees::new(51.48), Meters::new(0.0));
    let start = siderust::J2000.to::<tempoch::MJD>();
    let end = start + Days::new(5.0);
    let step = Days::new(1.0);
    let series = MoonPhaseSeries::<Vsop87Ephemeris>::sample_topocentric(start, end, step, site);
    assert_eq!(series.len(), 6);
    for (_, geom) in &series {
        assert!(
            geom.illuminated_fraction.value() >= 0.0 && geom.illuminated_fraction.value() <= 1.0
        );
    }
}

// ---------------------------------------------------------------------------
// Display impls
// ---------------------------------------------------------------------------

#[test]
fn display_impls_produce_text() {
    assert_eq!(format!("{}", MoonPhaseLabel::FullMoon), "Full Moon");
    assert_eq!(format!("{}", PhaseKind::NewMoon), "New Moon");
    assert_eq!(
        format!("{}", MoonPhaseLabel::WaxingCrescent),
        "Waxing Crescent"
    );
    assert_eq!(format!("{}", PhaseKind::LastQuarter), "Last Quarter");
}