Skip to content

Plugin System Overview

AerEO is built around plain Python functions. Search providers, readers, processors, reprojectors, writers, and task builders are all plugins.

How plugins are discovered

AerEO scans the aereo.plugins Python entry-point group at runtime. The prefix of the entry-point name tells AerEO which stage the plugin belongs to, and each stage has a typed Protocol that defines the input/output contract:

Prefix Stage Example Input → Output
search_ Search provider search_stac catalog query → GeoDataFrame[AssetSchema]
task_builder_ Task builder build_grouped_tasks assets + job → Sequence[ExtractionTask]
read_ Reader read_odc_stac ExtractionTask → xr.Dataset
reproject_ Reprojector reproject_odc xr.Dataset → xr.Dataset
process_ Processor ndvi, qa_mask xr.Dataset → xr.Dataset
write_ Writer write_geotiff xr.Dataset → artifact path/URI

A plugin is a plain Python function. You do not need to subclass anything, but you must satisfy the Protocol and schema of the stage you are implementing.

Built-in plugins

The aereo.builtins package ships with common plugins:

  • Search: search_stac, search_earthaccess
  • Task builder: build_grouped_tasks
  • Reader: read_odc_stac
  • Reprojectors: reproject_odc, reproject_swath, reproject_pyresample
  • Processors: select_bands, qa_mask, ndvi, ndwi, normalize, composite
  • Writer: write_geotiff

External plugins include search_aws_goes, read_satpy, search_tessera, and read_tessera.

Using plugins

Plugins are passed directly to ExtractionJob or job.search() / job.build_tasks():

from aereo.builtins import search_stac, build_grouped_tasks, read_odc_stac, write_geotiff
from aereo.executors import LocalExecutor
from aereo.pipeline import ExtractionJob

job = ExtractionJob(
    name="demo",
    grid_dist=10_000,
    output_uri="/tmp/demo",
    read=read_odc_stac,
    write=write_geotiff,
    target_aoi=aoi,
)

assets = job.search(search_stac, ...)
tasks = job.build_tasks(assets, build_grouped_tasks)
artifacts = job.execute(tasks, executor=LocalExecutor(workers=2))

Listing installed plugins

from aereo.registry import AereoRegistry

registry = AereoRegistry()
print(registry.list_supported_collections())
print(list(registry.list_all_params()))

Next steps