brahe 1.6.1

Brahe is a modern satellite dynamics library for research and engineering applications designed to be easy-to-learn, high-performance, and quick-to-deploy. The north-star of the development is enabling users to solve meaningful problems and answer questions quickly, easily, and correctly.
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

"""
Base utilities for Python benchmark implementations.
"""

import os
import time
from pathlib import Path

import brahe


def _find_orekit_eop_file() -> str | None:
    """Find the OreKit EOP finals2000A.all file."""
    orekit_data = os.environ.get(
        "OREKIT_DATA", str(Path.home() / ".orekit" / "orekit-data")
    )
    eop_path = (
        Path(orekit_data)
        / "Earth-Orientation-Parameters"
        / "IAU-2000"
        / "finals2000A.all"
    )
    if eop_path.exists():
        return str(eop_path)
    return None


def _find_orekit_sw_file() -> str | None:
    """Find the OreKit CSSI SpaceWeather-All file."""
    orekit_data = os.environ.get(
        "OREKIT_DATA", str(Path.home() / ".orekit" / "orekit-data")
    )
    sw_path = (
        Path(orekit_data)
        / "CSSI-Space-Weather-Data"
        / "SpaceWeather-All-v1.2.txt"
    )
    if sw_path.exists():
        return str(sw_path)
    return None


def ensure_eop():
    """Initialize EOP using OreKit's real IERS data if available, else fallback."""
    if not brahe.get_global_eop_initialization():
        eop_path = _find_orekit_eop_file()
        if eop_path:
            provider = brahe.FileEOPProvider.from_file(eop_path, True, "Hold")
            brahe.set_global_eop_provider(provider)
        else:
            # Fallback: download from IERS
            brahe.initialize_eop()


def ensure_sw():
    """Initialize space weather using OreKit's CSSI file when available so
    brahe and Orekit drag models read identical Ap / F10.7 inputs. Falls
    back to brahe's bundled file when the OreKit table isn't on disk.

    Aligning brahe on the same CSSI ``SpaceWeather-All-v1.2.txt`` that
    Orekit's ``CssiSpaceWeatherData`` reads is the single biggest lever
    we have for closing the brahe-vs-Orekit residual on the
    ``RK4 + 80x80 + drag + SRP`` task — drag-SW input differences
    were the dominant remaining gap at that fidelity.
    """
    if brahe.get_global_sw_initialization():
        return
    sw_path = _find_orekit_sw_file()
    if sw_path:
        provider = brahe.FileSpaceWeatherProvider.from_file(sw_path, "Hold")
        brahe.set_global_space_weather_provider(provider)
    else:
        brahe.initialize_sw()


def time_iterations(func, iterations: int) -> tuple[list[float], list]:
    """Time a function over multiple iterations.

    Returns (times_seconds, results_from_first_iteration).
    """
    times = []
    first_results = None

    for i in range(iterations):
        start = time.perf_counter()
        results = func()
        elapsed = time.perf_counter() - start
        times.append(elapsed)

        if i == 0:
            first_results = results

    return times, first_results