Skip to content

Getting Started

This guide will help you install and start using the Ecosystem Integrity Index package.

Prerequisites

  • Python 3.10 or higher
  • Google Earth Engine account (sign up here)

Installation

From source

git clone https://github.com/landler-open-data/ecosystem-integrity-index.git
cd ecosystem-integrity-index
pip install -e ".[client]"

Optional dependency sets

  • .[client] for raster downloads and local data handling
  • .[compute] to compute EII components on the fly
  • .[training] for model training utilities
  • .[docs] to build the documentation locally

Authentication

Before using the package, you need to authenticate with Google Earth Engine:

import ee

# First time: authenticate via browser
ee.Authenticate()

# Initialize with your project
ee.Initialize(project='your-gee-project-id')

Basic Usage

Extract EII for a polygon

from eii.client import get_stats

# Define your area of interest
polygon = ee.Geometry.Rectangle([-60, -10, -55, -5])

# Get EII statistics
stats = get_stats(polygon)
print(stats)

Download a raster for an AOI

from eii.client import get_raster

dataset = get_raster(polygon, include_components=True, output_format="memory")
print(dataset)

Next Steps