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
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. |
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. |