Skip to main content

⚠️ Breaking Change in v0.1.0

v0.1.0 includes a major refactor with breaking API changes.

Xee: Xarray + Google Earth Engine

Xee Logo

Xee is an Xarray backend for Google Earth Engine. Open ee.Image / ee.ImageCollection objects as lazy xarray.Datasets and analyze petabyte-scale Earth data with the scientific Python stack.

image image Conda Recipe image Conda Downloads

Install

For the latest v0.1.0 prerelease:

pip install --upgrade --pre xee

For all installation paths (including stable line and conda), see docs/installation.md.

Minimal example

import ee
import xarray as xr
from xee import helpers

# Authenticate once (on a persistent machine):
#   earthengine authenticate

project = 'PROJECT-ID'  # Set your Earth Engine registered Google Cloud project ID
# Initialize (high-volume endpoint recommended for reading stored collections)
ee.Initialize(project=project, opt_url='https://earthengine-highvolume.googleapis.com')

# Open a dataset by matching its native grid
ic = ee.ImageCollection('ECMWF/ERA5_LAND/MONTHLY_AGGR')
grid = helpers.extract_grid_params(ic)
ds = xr.open_dataset(ic, engine='ee', **grid)
print(ds)

Next steps:

Features

  • Lazy, parallel pixel retrieval through Earth Engine
  • Flexible output grid definition (fixed resolution or fixed shape)
  • CF-friendly dimension order: [time, y, x]
  • Plays nicely with Xarray, Dask, and friends

Community & Support

Contributing

See Contributing and sign the required CLA. For local development, we recommend the Pixi environments defined in this repository for reproducible test and docs runs.

License

Apache 2.0

SPDX-License-Identifier: Apache-2.0

This is not an official Google product.

Metadata

Release files for xee 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xee 0.1.2
File Size Uploaded Provenance Actions
xee-0.1.2.tar.gz 561.4 kB Without provenance Details for xee-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for xee 0.1.2
File Interpreter ABI Platform Actions
xee-0.1.2-py3-none-any.whl Python 3 none any Details for xee-0.1.2-py3-none-any.whl

Total release size: 598.5 kB

Release files / xee-0.1.2.tar.gz

Download URL xee-0.1.2.tar.gz
Size 561.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a24571e5c066e8e103bac5f40d2cf64f217161a3a1e09182baad89325df7bccb
BLAKE2b-256 checksum
How to use checksums
30c6f817e2616156b78838ff7e10fd9d80f967ceceeed667e66fcfd8f83d610c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.13

Release files / xee-0.1.2-py3-none-any.whl

Download URL xee-0.1.2-py3-none-any.whl
Size 37.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0194b0cdd0846f7710cbd2abbbd1aad7bec1b50da1b6f79ad87819587f77d1b3
BLAKE2b-256 checksum
How to use checksums
af6a0949d7f43d0b816b07d65d2745825a87ed99f29bae670187ffbd4ba25fda
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.13

Security for xee 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page