Skip to content

API Reference

This section contains the complete API documentation for the eii package.

Modules

eii.client

Client interface for EII data access from Google Earth Engine.

  • get_stats() - Extract EII statistics for a geometry
  • get_raster() - Download EII raster for a geometry
  • get_layers() - Get EII and/or integrity component layers as ee.Image
  • ASSETS - Asset paths and metadata

eii.client.analysis

Analysis utilities for EII data.

  • get_zonal_stats() - Zonal statistics for feature collections
  • compare_methods() - Compare different aggregation methods

eii.compute

Core computation utilities for on-the-fly EII.

  • calculate_eii() - Compute EII from component layers
  • calculate_functional_integrity() - NPP-based functional integrity
  • calculate_structural_integrity() - Structural integrity (core area)
  • calculate_compositional_integrity() - Compositional integrity (BII)

eii.training

Model training utilities for advanced users.

Quick Reference

# Most common imports
from eii.client import get_stats, get_raster, get_layers, ASSETS
from eii.client import get_zonal_stats, compare_methods
from eii.compute import calculate_eii, calculate_functional_integrity