Skip to main content

edown

edown is a Google Earth Engine downloader that discovers images for a location and time range, downloads each image in its native grid as GeoTIFF, and can optionally build Zarr stacks for grid-compatible groups.

What It Does

  • Searches an ImageCollection by date range and AOI.
  • Preserves each image's native CRS and transform instead of forcing a common projection.
  • Downloads intersecting chunks in parallel across multiple images.
  • Writes a run manifest with discovery, download, and stack metadata.
  • Builds Zarr outputs only when images share an alignment signature.

Installation

python -m pip install edown

edown supports Python 3.9 through 3.14.

For local development:

python -m pip install -e ".[dev,stack,dask]"

Authentication

edown prefers Earth Engine service-account credentials when both of these environment variables are set:

  • GEE_SERVICE_ACCOUNT
  • GEE_SERVICE_ACCOUNT_KEY

Otherwise it tries, in order:

  • persistent Earth Engine user credentials
  • Google application default credentials

If both user-auth and ADC refresh tokens are stale, reauthenticate before running downloads.

CLI

Search only:

edown search \
  --collection-id COPERNICUS/S2_SR_HARMONIZED \
  --start-date 2024-06-01 \
  --end-date 2024-06-07 \
  --bbox -0.15 51.48 0.02 51.56 \
  --band B4 \
  --band B8 \
  --manifest-path manifests/search.json

Download native-grid GeoTIFFs:

edown download \
  --collection-id COPERNICUS/S2_SR_HARMONIZED \
  --start-date 2024-06-01 \
  --end-date 2024-06-07 \
  --geojson docs/examples/aoi.geojson \
  --band B4 \
  --band B8 \
  --output-root ./data

Build Zarr stacks from compatible groups:

edown stack \
  --manifest-path manifests/run.json \
  --output-root ./data

Run the bundled end-to-end Sentinel-2 example:

python examples/s2_find_download_stack.py --output-root ./data/live-s2

Python API

from pathlib import Path

from edown import AOI, DownloadConfig, download_images

config = DownloadConfig(
    collection_id="COPERNICUS/S2_SR_HARMONIZED",
    start_date="2024-06-01",
    end_date="2024-06-07",
    aoi=AOI.from_bbox((-0.15, 51.48, 0.02, 51.56)),
    bands=("B4", "B8"),
    output_root=Path("data"),
)

summary = download_images(config)
print(summary.manifest_path)

Live Integration Test

The default test suite is mocked and offline. For a real end-to-end Sentinel-2 smoke test, install the stack extras:

python -m pip install -e ".[dev,stack]"

Then run:

export EDOWN_RUN_LIVE_TESTS=1
python -m pytest -s tests/test_live_s2.py

Default live settings:

  • collection: COPERNICUS/S2_SR_HARMONIZED
  • dates: 2024-06-01 through 2024-06-03
  • bbox: -0.1278,51.5072,-0.1270,51.5078
  • bands: B4,B8

You can override them with:

  • EDOWN_LIVE_COLLECTION_ID
  • EDOWN_LIVE_START_DATE
  • EDOWN_LIVE_END_DATE
  • EDOWN_LIVE_BBOX
  • EDOWN_LIVE_BANDS

This requires valid Earth Engine authentication, via either:

  • GEE_SERVICE_ACCOUNT and GEE_SERVICE_ACCOUNT_KEY (path to a service-account JSON key file)
  • existing local Earth Engine credentials
  • valid Google application default credentials

Notes

  • --chunk-size is only used as an exact size when --chunk-size-mode fixed is set.
  • In the default auto mode, edown estimates chunk sizes per image from the AOI window and request byte limits.

Development

  • python -m pytest
  • ruff check .
  • mypy src
  • python -m build

Docs are built with MkDocs Material and published to GitHub Pages from GitHub Actions.

Metadata

Release files for edown 0.2.1

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

Source distribution (sdist)

Source distribution for edown 0.2.1
File Size Uploaded Provenance Actions
edown-0.2.1.tar.gz 224.1 kB With provenance Details for edown-0.2.1.tar.gz

Built distribution (wheel)

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

Total release size: 258.1 kB

Release files / edown-0.2.1.tar.gz

Download URL edown-0.2.1.tar.gz
Size 224.1 kB
Tags Source
SHA-256 checksum
How to use checksums
006ea56b3e560d36a336d38d22c7cd7643f6ee2f41ae77c0b7fac78a30e3c98c
BLAKE2b-256 checksum
How to use checksums
173a44834fc46846b713533aa194af28e940548c7e09573c5464377b736ab995
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 3, 2026.

Transparency log

Release files / edown-0.2.1-py3-none-any.whl

Download URL edown-0.2.1-py3-none-any.whl
Size 34.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d88542077487556a1c56c4bc0662c47a275fa3041475c679ef76f95998689c38
BLAKE2b-256 checksum
How to use checksums
7405f8080277ca4e39422956b9ba76cdceed48247a3bfd4e44a7f65e18bd2c01
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 3, 2026.

Transparency log

Security for edown 0.2.1

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for edown-0.2.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 3, 2026.

Transparency log

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