astrora_core 0.1.1

Astrora - Rust-backed astrodynamics library - core computational components
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
"""
Tests for orbit animation functionality.

Tests both matplotlib (2D) and plotly (3D) animation helpers.
"""

import numpy as np
import pytest
from astropy import units as u

# Import animation module - may not be available if matplotlib/plotly missing
try:
    from astrora.plotting.animation import animate_orbit, animate_orbit_3d

    HAS_ANIMATION = True
except ImportError:
    HAS_ANIMATION = False

try:
    import matplotlib

    matplotlib.use("Agg")  # Non-interactive backend for testing
    import matplotlib.animation as mpl_animation
    import matplotlib.pyplot as plt

    HAS_MATPLOTLIB = True
except ImportError:
    HAS_MATPLOTLIB = False

try:
    import plotly.graph_objects as go

    HAS_PLOTLY = True
except ImportError:
    HAS_PLOTLY = False

from astrora.bodies import Earth, Mars
from astrora.twobody import Orbit

# Skip all tests if animation module not available
pytestmark = pytest.mark.skipif(not HAS_ANIMATION, reason="Animation module not available")


class TestAnimateOrbit:
    """Tests for 2D matplotlib orbit animations."""

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_single_orbit_basic(self):
        """Test basic 2D animation of a single orbit."""
        # Create a simple circular orbit
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        # Create animation
        anim = animate_orbit(orbit, num_frames=10, fps=10)

        # Verify animation object
        assert isinstance(anim, mpl_animation.FuncAnimation)
        assert anim is not None

        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_single_orbit_with_units(self):
        """Test animation with astropy units."""
        r = [7000, 0, 0] << u.km
        v = [0, 7.546, 0] << u.km / u.s
        orbit = Orbit.from_vectors(Earth, r, v)

        anim = animate_orbit(orbit, num_frames=10)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_multiple_orbits(self):
        """Test animating multiple orbits simultaneously."""
        # Create two different orbits
        orbit1 = Orbit.from_classical(
            Earth,
            a=7000 << u.km,
            ecc=0.01 << u.one,
            inc=0 << u.deg,
            raan=0 << u.deg,
            argp=0 << u.deg,
            nu=0 << u.deg,
        )

        orbit2 = Orbit.from_classical(
            Earth,
            a=8000 << u.km,
            ecc=0.05 << u.one,
            inc=10 << u.deg,
            raan=0 << u.deg,
            argp=0 << u.deg,
            nu=0 << u.deg,
        )

        anim = animate_orbit([orbit1, orbit2], num_frames=10)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_custom_duration(self):
        """Test animation with custom duration."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        # Animate for half a period
        period = orbit.period.value if hasattr(orbit.period, "value") else orbit.period
        anim = animate_orbit(orbit, duration=period / 2, num_frames=10)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_without_trail(self):
        """Test animation without showing orbital trail."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        anim = animate_orbit(orbit, trail=False, num_frames=10)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_dark_mode(self):
        """Test animation with dark theme."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        anim = animate_orbit(orbit, dark=True, num_frames=10)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_without_time_display(self):
        """Test animation without time annotation."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        anim = animate_orbit(orbit, show_time=False, num_frames=10)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_custom_fps(self):
        """Test animation with custom frame rate."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        anim = animate_orbit(orbit, num_frames=20, fps=30)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_custom_axes(self):
        """Test animation on provided axes."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        fig, ax = plt.subplots()
        anim = animate_orbit(orbit, ax=ax, num_frames=10)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        # Verify animation uses the provided axes
        assert ax in fig.get_axes()
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_elliptical_orbit(self):
        """Test animation of elliptical orbit."""
        orbit = Orbit.from_classical(
            Earth,
            a=10000 << u.km,
            ecc=0.3 << u.one,
            inc=30 << u.deg,
            raan=45 << u.deg,
            argp=60 << u.deg,
            nu=0 << u.deg,
        )

        anim = animate_orbit(orbit, num_frames=15)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animate_different_attractor(self):
        """Test animation with different central body (Mars)."""
        orbit = Orbit.from_classical(
            Mars,
            a=5000 << u.km,
            ecc=0.01 << u.one,
            inc=0 << u.deg,
            raan=0 << u.deg,
            argp=0 << u.deg,
            nu=0 << u.deg,
        )

        anim = animate_orbit(orbit, num_frames=10)

        assert isinstance(anim, mpl_animation.FuncAnimation)
        plt.close("all")


class TestAnimateOrbit3D:
    """Tests for 3D plotly orbit animations."""

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_single_orbit_basic(self):
        """Test basic 3D animation of a single orbit."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        fig = animate_orbit_3d(orbit, num_frames=10)

        assert isinstance(fig, go.Figure)
        assert len(fig.frames) == 10

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_with_units(self):
        """Test 3D animation with astropy units."""
        r = [7000, 0, 0] << u.km
        v = [0, 0, 7.546] << u.km / u.s
        orbit = Orbit.from_vectors(Earth, r, v)

        fig = animate_orbit_3d(orbit, num_frames=10)

        assert isinstance(fig, go.Figure)
        assert len(fig.frames) == 10

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_multiple_orbits(self):
        """Test 3D animation of multiple orbits."""
        orbit1 = Orbit.from_classical(
            Earth,
            a=7000 << u.km,
            ecc=0.01 << u.one,
            inc=0 << u.deg,
            raan=0 << u.deg,
            argp=0 << u.deg,
            nu=0 << u.deg,
        )

        orbit2 = Orbit.from_classical(
            Earth,
            a=8000 << u.km,
            ecc=0.05 << u.one,
            inc=20 << u.deg,
            raan=30 << u.deg,
            argp=0 << u.deg,
            nu=0 << u.deg,
        )

        fig = animate_orbit_3d([orbit1, orbit2], num_frames=10)

        assert isinstance(fig, go.Figure)
        assert len(fig.frames) == 10

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_custom_duration(self):
        """Test 3D animation with custom duration."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        period = orbit.period.value if hasattr(orbit.period, "value") else orbit.period
        fig = animate_orbit_3d(orbit, duration=period / 2, num_frames=10)

        assert isinstance(fig, go.Figure)
        assert len(fig.frames) == 10

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_without_trail(self):
        """Test 3D animation without orbital trail."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        fig = animate_orbit_3d(orbit, trail=False, num_frames=10)

        assert isinstance(fig, go.Figure)
        # Should have fewer traces per frame without trail
        assert len(fig.frames) == 10

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_dark_mode(self):
        """Test 3D animation with dark theme."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        fig = animate_orbit_3d(orbit, dark=True, num_frames=10)

        assert isinstance(fig, go.Figure)
        # Check that dark template is applied by checking the template name
        assert hasattr(fig.layout, "template")

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_controls(self):
        """Test that 3D animation has play/pause controls."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        fig = animate_orbit_3d(orbit, num_frames=10)

        # Check for updatemenus (play/pause buttons)
        assert len(fig.layout.updatemenus) > 0
        assert any(
            "Play" in str(button) for menu in fig.layout.updatemenus for button in menu.buttons
        )

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_slider(self):
        """Test that 3D animation has time slider."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        fig = animate_orbit_3d(orbit, num_frames=10)

        # Check for slider
        assert len(fig.layout.sliders) > 0
        slider = fig.layout.sliders[0]
        assert len(slider.steps) == 10  # One step per frame

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_inclined_orbit(self):
        """Test 3D animation of inclined orbit."""
        # Use from_vectors to avoid any classical element conversion issues
        r = np.array([7000e3, 3000e3, 2000e3])  # Inclined orbit
        v = np.array([-2000, 6000, 4000])
        orbit = Orbit.from_vectors(Earth, r, v)

        fig = animate_orbit_3d(orbit, num_frames=15)

        assert isinstance(fig, go.Figure)
        assert len(fig.frames) == 15

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_animate_3d_custom_fps(self):
        """Test 3D animation with custom frame rate."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        fig = animate_orbit_3d(orbit, num_frames=20, fps=30)

        assert isinstance(fig, go.Figure)
        assert len(fig.frames) == 20


class TestAnimationIntegration:
    """Integration tests for animation functionality."""

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animation_preserves_orbit_properties(self):
        """Test that animation doesn't modify original orbit."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        # Store original properties
        original_a = orbit.a
        original_ecc = orbit.ecc

        # Create animation
        anim = animate_orbit(orbit, num_frames=10)

        # Verify orbit unchanged
        assert orbit.a == original_a
        assert orbit.ecc == original_ecc

        plt.close("all")

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_3d_animation_preserves_orbit_properties(self):
        """Test that 3D animation doesn't modify original orbit."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        original_a = orbit.a
        original_inc = orbit.inc

        fig = animate_orbit_3d(orbit, num_frames=10)

        assert orbit.a == original_a
        assert orbit.inc == original_inc

    @pytest.mark.skipif(not HAS_MATPLOTLIB, reason="matplotlib not available")
    def test_animation_num_frames_parameter(self):
        """Test that num_frames parameter is respected."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        # Different frame counts
        for num_frames in [5, 10, 20, 50]:
            anim = animate_orbit(orbit, num_frames=num_frames)
            # Note: FuncAnimation doesn't expose frame count directly
            # but we can verify it was created successfully
            assert isinstance(anim, mpl_animation.FuncAnimation)
            plt.close("all")

    @pytest.mark.skipif(not HAS_PLOTLY, reason="plotly not available")
    def test_3d_animation_num_frames_parameter(self):
        """Test that num_frames parameter is respected in 3D."""
        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        for num_frames in [5, 10, 20, 30]:
            fig = animate_orbit_3d(orbit, num_frames=num_frames)
            assert len(fig.frames) == num_frames


class TestAnimationErrors:
    """Test error handling in animation functions."""

    def test_animate_orbit_no_matplotlib(self, monkeypatch):
        """Test error when matplotlib is not available."""
        if not HAS_MATPLOTLIB:
            pytest.skip("matplotlib not installed")

        # Mock matplotlib as unavailable
        import astrora.plotting.animation as anim_module

        monkeypatch.setattr(anim_module, "HAS_MATPLOTLIB", False)

        r = np.array([7000e3, 0, 0])
        v = np.array([0, 7546, 0])
        orbit = Orbit.from_vectors(Earth, r, v)

        with pytest.raises(ImportError, match="Matplotlib is required"):
            animate_orbit(orbit, num_frames=10)

    def test_animate_orbit_3d_no_plotly(self, monkeypatch):
        """Test error when plotly is not available."""
        if not HAS_PLOTLY:
            pytest.skip("plotly not installed")

        # Mock plotly as unavailable
        import astrora.plotting.animation as anim_module

        monkeypatch.setattr(anim_module, "HAS_PLOTLY", False)

        r = np.array([7000e3, 0, 0])
        v = np.array([0, 0, 7546])
        orbit = Orbit.from_vectors(Earth, r, v)

        with pytest.raises(ImportError, match="Plotly is required"):
            animate_orbit_3d(orbit, num_frames=10)


if __name__ == "__main__":
    pytest.main([__file__, "-v"])