Skip to content

Groundstation Functions

Functions for accessing curated groundstation location datasets.

All functions are available via brahe.datasets.groundstations.<function_name>.

load

groundstations_load builtin

groundstations_load(provider: str) -> list[PointLocation]

Load groundstation locations for a specific provider

Loads groundstation locations from embedded data. The data is compiled into the binary and does not require external files or internet connection.

Parameters:

Name Type Description Default
provider str

Provider name (case-insensitive). Available providers: - "atlas": Atlas Space Operations - "aws": Amazon Web Services Ground Station - "ksat": Kongsberg Satellite Services - "leaf": Leaf Space - "ssc": Swedish Space Corporation - "viasat": Viasat

required

Returns:

Type Description
list[PointLocation]

list[PointLocation]: List of PointLocation objects with properties: - name: Groundstation name - provider: Provider name - frequency_bands: List of supported frequency bands

Raises:

Type Description
RuntimeError

If provider is unknown or data cannot be loaded.

Example
import brahe as bh

# Load KSAT groundstations
ksat_stations = bh.datasets.groundstations.load("ksat")

for station in ksat_stations:
    print(f"{station.name}: ({station.lon():.2f}, {station.lat():.2f})")

# Check properties
props = ksat_stations[0].properties()
print(f"Frequency bands: {props['frequency_bands']}")

load_from_file

groundstations_load_from_file builtin

groundstations_load_from_file(filepath: str) -> list[PointLocation]

Load groundstations from a custom GeoJSON file

Loads groundstation locations from a user-provided GeoJSON file. The file must be a FeatureCollection with Point geometries.

Parameters:

Name Type Description Default
filepath str

Path to GeoJSON file.

required

Returns:

Type Description
list[PointLocation]

list[PointLocation]: List of PointLocation objects.

Raises:

Type Description
RuntimeError

If file cannot be read or parsed.

Example
import brahe as bh

# Load custom groundstations
stations = bh.datasets.groundstations.load_from_file("my_stations.geojson")

load_all

groundstations_load_all builtin

groundstations_load_all() -> list[PointLocation]

Load all groundstations from all providers

Convenience function to load groundstations from all available providers.

Returns:

Type Description
list[PointLocation]

list[PointLocation]: Combined list of all groundstations.

Raises:

Type Description
RuntimeError

If no groundstations can be loaded.

Example
import brahe as bh

all_stations = bh.datasets.groundstations.load_all()
print(f"Loaded {len(all_stations)} total groundstations")

list_providers

groundstations_list_providers builtin

groundstations_list_providers() -> list[str]

Get list of available groundstation providers

Returns:

Type Description
list[str]

list[str]: List of provider names that can be used with load().

Example
import brahe as bh

providers = bh.datasets.groundstations.list_providers()
print(f"Available: {', '.join(providers)}")