API Reference
The complete public API. If you're new, start with Getting Started and Concepts; this section is the exhaustive symbol-level reference.
Where things live
| You want to… | See |
|---|---|
| Discover events / hazard, download rasters | API — floods, hazard, download |
| Work with the object a query returns | FloodFrame |
| Plot / explore / footprints / depth | Visualization |
Configure via EUROFLOOD_* env vars |
Configuration |
| Use the CLI | CLI |
| Internals: query/hazard pipelines, repositories | Pipelines · Services |
| Producer build pipeline | Pipelines · HPC Runbook |
The public surface
Everything importable from the top-level euroflood package:
import euroflood as ef
ef.floods, ef.hazard, ef.download, ef.mirror_hazard # queries + fetch
ef.FloodFrame # what floods()/hazard() return
ef.plot, ef.explore, ef.footprints # viz (needs [viz] extra)
ef.plot_depth, ef.explore_depth, ef.open_depth, ef.DepthRaster
ef.settings, ef.setup_logging # config + logging