Starlink¶

Directory holding the cached manifest and ephemeris files.

For the default base URL this is $BRAHE_CACHE/starlink. For any other base URL it is $BRAHE_CACHE/starlink/mirrors/<label>, where <label> is derived from the base URL's host so that clients pointed at different mirrors do not read or write each other's cached manifest and ephemeris files.

Returns:

Raises:

Cached ephemeris files, sorted by name.

Returns:

Raises:

The cached manifest, whatever its age, without touching the network.

Returns:

Raises:

Downloads every file the manifest lists that is not already cached, using up to concurrency threads that share the rate limiter.

The full manifest is about 11,100 files and about 22 GB, so a first run against the public mirror is a long transfer. Stops at the first failure and returns it. Files already cached are not re-fetched. No files are pruned; superseded files for a satellite whose file is downloaded are still evicted. Call prune_cache to remove files the manifest no longer lists.

Parameters:

Returns:

Raises:

Downloads a satellite's current ephemeris file into the cache.

The manifest names one file per satellite; if that file is already cached no request is made. After a download every other cached file for the same NORAD ID is deleted.

Parameters:

Returns:

Raises:

Downloads (if needed) and parses a satellite's current ephemeris.

Parameters:

Returns:

Raises:

Returns the manifest, serving the cached copy while it is younger than cache_max_age and refreshing it with a conditional GET otherwise.

BRAHE_NETWORK_MODE applies as for the other clients: offline serves a cached manifest of any age, offline-strict serves only a fresh one and rejects a stale or missing one, and a refresh that fails is an error rather than a silent fall back to the stale copy.

Returns:

Raises:

1
2
3
4

import brahe as bh

manifest = bh.StarlinkClient().get_manifest()
assert len(manifest) > 0

Downloads (if needed) a satellite's ephemeris as an OrbitTrajectory in the file's state frame with covariance rotated from RTN using the block-diagonal (inertial) convention by default.

Parameters:

Returns:

Raises:

1
2
3

import brahe as bh

traj = bh.StarlinkClient().get_trajectory(100001)

Like get_trajectory with an explicit RTN covariance convention.

Parameters:

Returns:

Raises:

The listing that was current before the last change, for changed_since.

Returns:

Raises:

Deletes cached ephemeris files the current manifest no longer lists.

Returns:

Raises:

Fetches the manifest from the server regardless of cache age.

Sends the cached ETag and Last-Modified as conditional headers; a 304 answer touches the cached file so it is fresh again. A changed listing moves the old copy to MANIFEST.previous.txt before the new one is written.

Returns:

Raises:

Runs download_all and writes every file into destination.

With keep_cached false each cached file is moved, so destination holds every ephemeris and the cache holds none and a later download_ephemeris or download_all call downloads them again; with keep_cached true each is copied and the cached copies stay.

Parameters:

Returns:

Raises:

Downloads (if needed) a satellite's ephemeris and writes it to destination.

An existing directory, or a path whose last component has no extension, is treated as a directory (created if missing) and the original file name is kept; a path with an extension is the file name. With keep_cached false the cached file is moved, so destination becomes the only copy and a later download_ephemeris call downloads it again; with keep_cached true it is copied and the cached copy stays.

Parameters:

Returns:

Raises:

Entries whose file name differs from, or is absent in, other.

Parameters:

Returns:

All entries in manifest order.

Returns:

Entry for a NORAD catalog number.

Parameters:

Returns:

Entry whose object name matches exactly.

Parameters:

Returns:

Whether the manifest has no entries.

Returns:

Parses manifest text; blank lines are skipped and any other line must be a Space-Track file name.

Parameters:

Returns:

Raises:

1
2
3
4
5
6
7
8

import brahe as bh

reference = bh.Epoch(2026, 9, 11, 6, 0, 0.0, 0.0, time_system=bh.UTC)
manifest = bh.StarlinkManifest.parse(
    "MEME_100001_STARLINK-38128_2540142_Operational_1473385380_UNCLASSIFIED.txt\n",
    reference,
)
assert manifest.entries()[0].norad_cat_id == 100001

The manifest as a polars DataFrame.

Columns: norad_cat_id (UInt32), object_name (String), category (String), ephemeris_start (Datetime, milliseconds), ephemeris_stop (Datetime, milliseconds, null when the name carries no stop), file_name (String).

Returns:

Raises:

1
2
3
4
5

import brahe as bh

client = bh.StarlinkClient()
df = client.get_manifest().to_dataframe()
print(df.head())

The file name exactly as listed in the manifest, which is what the mirror serves and what the cache stores.

Returns: