Skip to content

API Reference🔗

This section provides comprehensive API documentation for the water-timeseries package.

Modules🔗

Core Dataset Classes🔗

  • Dataset - Main dataset processing classes (LakeDataset, DWDataset, JRCDataset)

Breakpoint Detection🔗

  • Breakpoint - Breakpoint detection methods for identifying changes in water extent

Data Download🔗

  • Downloader - Google Earth Engine data downloader (EarthEngineDownloader)

Utilities🔗

  • Utils - Plotting and helper utilities

Usage🔗

All modules are designed to work with xarray datasets:

import xarray as xr
from water_timeseries.dataset import DWDataset

# Load data
ds = xr.open_dataset("data.nc")

# Process
processor = DWDataset(ds)