Xee Documentation

Breaking change in v0.1.0+

Xee v0.1.0 introduced a refactored API with breaking changes relative to the 0.0.x series. This documentation reflects the v0.1.0+ API.

If you are upgrading from 0.0.x, see the Migration Guide.

Xee is an Xarray extension for Google Earth Engine that lets you open ee.Image and ee.ImageCollection objects as lazy xarray.Datasets.

• Quickstart
  • 1. Install
  • 2. Earth Engine access
  • 3. Open your first dataset
  • 4. Next steps
  • 5. Minimal workflow recap
  • 6. Example: custom AOI at fixed size
  • 7. Having trouble?
• Installation
  • Install
  • Earth Engine setup
• Core Concepts
  • Pixel Grid Parameters
  • Dimension Ordering
  • Stored vs Computed Collections
  • Choosing a Grid Strategy
  • CRS Units & Transforms
  • Chunking & Lazy Loading
  • Error Patterns
  • Helpers vs Manual Override
  • Safe Defaults
• User Guide
  • Match Source Grid
  • Fit Area of Interest (AOI) to a Shape
  • Fit Area of Interest (AOI) to a Scale (Resolution)
  • Custom Region at Source Resolution
  • Manual Override
  • Pre-Processed ImageCollection
  • Single Image
  • Visualize a Time Slice
  • Further Resources
• Open Dataset Reference (engine='ee')
  • How The Call Chain Works
  • Required vs Optional Parameters
  • Canonical Parameter List
  • Parameter Name Mapping (User API vs Core Backend)
  • Practical Parameter Guide
  • fast_time_slicing Deep Dive
  • Common Recipes
  • Object vs URI Inputs
• Client vs. Server
  • Examples
• Performance & Limits
  • Endpoints
  • Quotas & Request Parallelism
  • Chunk Size Considerations
  • Memory Pressure
  • Common Optimizations
  • Troubleshooting Slowdowns
  • Export & Large Pipelines
• Xee API
  • User grid helpers
  • Core extension backend
  • Other utilities
• Migration Guide: Xee v0.1.0
  • Quick Migration Checklist
  • 1. Geography Specification Changes
  • 2. Dimension Ordering Changes
  • 3. Common Migration Patterns
  • 4. Understanding Grid Parameters
  • 5. Troubleshooting
  • 6. Testing Your Migration
  • 7. Additional Resources
  • Need Help?
• FAQ
  • Why is the y-scale negative?
  • How do I pick between grid_shape and grid_scale?
  • I get 429 quota errors. What do I do?
  • Can I open a computed ee.ImageCollection?
  • How do I reproduce the same grid later?
  • How can I export to Zarr?
  • Why did dimension ordering change?
  • I’m seeing empty arrays / NaNs.
  • Do I need shapely geometries?
  • ds.to_netcdf() fails with ValueError: could not safely cast array from int64 to int32
• Why Xee?
  • Goals
  • Approach
  • An array by any other name? (Xee vs Zarr)
• How to Contribute
  • Before you begin
  • Contribution process
• Code of Conduct
  • Our Pledge
  • Our Standards
  • Our Responsibilities
  • Scope
  • Conflict Resolution
  • Attribution