API Reference#

This page provides an auto-generated summary of EOForestSTAC’s public API. For usage examples and conceptual background, refer to the EOForestSTAC User Guide guide.

Providers#

Discovery#

eoforeststac.providers.discovery.DiscoveryProvider(...)

STAC-based discovery utilities for EOForestSTAC catalogs (themed).

Data loading#

eoforeststac.providers.zarr.ZarrProvider(...)

Generic STAC-driven Zarr provider.

Subsetting#

eoforeststac.providers.subset.subset(ds, *)

Combined spatial + temporal subsetting.

Alignment#

eoforeststac.providers.align.DatasetAligner(*)

Align multiple xarray Datasets onto a common spatial grid.

Base provider#

eoforeststac.providers.base.BaseProvider(...)

Catalog#

Factory functions#

eoforeststac.catalog.factory.create_collection(cfg)

Create a STAC Collection with rich metadata for STAC Browser.

eoforeststac.catalog.factory.create_item(...)

Create a STAC Item with rich metadata for a dataset version.

eoforeststac.catalog.root.build_catalog([...])

Build the internal EOFOREST root catalog and optionally also write a browser-friendly mirror.

eoforeststac.catalog.root.build_browser_catalog([...])

Convenience wrapper: write only the browser-facing variant and return it.

Writers#

Base writer#

eoforeststac.writers.base.BaseZarrWriter(...)

Generic writer for converting EO data into Zarr and storing it in Ceph/S3.

Product writers#

eoforeststac.writers.CCI_biomass.CCIBiomassWriter(...)

Writer for the ESA CCI Biomass product (v6+).

eoforeststac.writers.efda.EFDAWriter(...[, ...])

Writer for the European Forest Disturbance Atlas (EFDA).

eoforeststac.writers.gami.GAMIWriter(...[, ...])

Writer for the Global Age Mapping Integration (GAMI) product.

eoforeststac.writers.gami_ageclass.GAMIAgeClassWriter(...)

Writer for GAMI age-class fraction product (multi-resolution).

eoforeststac.writers.hansen_gfc.HansenGFCWriter(...)

Writer for Hansen Global Forest Change (GFC) v1.12.

eoforeststac.writers.jrc_gfc.JRCGFCWriter(...)

Writer for JRC Global Forest Cover 2020 (v3).

eoforeststac.writers.jrc_tmf.JRCTMFWriter(...)

Writer for Tropical Moist Forest (TMF) products (v1-2024).

eoforeststac.writers.liu_biomass.LiuBiomassWriter(...)

Writer for European canopy cover, canopy height and aboveground biomass derived from PlanetScope imagery (Liu et al., v0.1).

eoforeststac.writers.potapov_height.PotapovHeightWriter(...)

Writer for Potapov canopy height product distributed as one VRT per reference year.

eoforeststac.writers.potapov_lcluc.PotapovLCLUCWriter(...)

Writer for Potapov LCLUC product distributed as one VRT per reference year.

eoforeststac.writers.radd_europe.RADDEuropeWriter(...)

Streaming writer for RADD Europe alert dates (YYddd) + forest mask (0/1),

eoforeststac.writers.restor_landuse.RestorLanduseWriter(...)

Writer for Annual Land Use and Land Cover maps for the Brazilian Amazon (2000–2022).

eoforeststac.writers.robinson_cr.RobinsonCRWriter(...)

Writer for Robinson et al. global Chapman–Richards (CR) curve parameters and derived carbon accumulation metrics.

eoforeststac.writers.saatchi_biomass.SaatchiBiomassWriter(...)

Writer for Saatchi et al. (2020) global aboveground biomass (AGB).

eoforeststac.writers.forestpaths_genus.ForestPathsGenusWriter(...)

Writer for the European Tree Genus Map (10 m, 2020).

Core utilities#

eoforeststac.core.assets.create_zarr_asset(...)

eoforeststac.core.config

eoforeststac.core.zarr