Skip to main content

Pulls data from Google Earth Engine, syncs it to Google Drive, and downloads files.

Project description

Project Summary

Earth-Engine-Wildfire-Data is a Python command-line utility and library for extracting and transforming wildfire-related geospatial data from Google Earth Engine. It supports:

  • Access to MODIS, VIIRS, GRIDMET, and other remote sensing datasets.

  • Filtering wildfire perimeters by date, size, and region.

  • Combining daily and final fire perimeters.

  • Generating YAML config files for use in simulation or prediction tools.

  • Command-line configurability with persistent YAML-based settings.

  • This tool is intended for researchers, data scientists, or modelers working with wildfire data pipelines, particularly those interested in integrating Earth Engine datasets into geospatial ML workflows.

  • The Trello page contains the current development status.

Prerequisite

Requires at least python 3.10.

As of mid-2023, Google Earth Engine access must be linked to a Google Cloud Project, even for free/non-commercial usage. So sign up for a non-commercial earth engine account.

🔐 Google API Setup Instructions

To run this project with Google Earth Engine and Google Drive access, follow the steps below to create and configure your credentials.


1. ✅ Create a Service Account

In the Google Cloud Console, do the following:

  • Go to IAM & Admin → Service Accounts → Create Service Account
  • Assign the following roles to the Service Account:
    • Owner
    • Service Usage Admin
    • Service Usage Consumer
    • Storage Admin
    • Storage Object Creator

2. 🔑 Assign Roles to Your Personal Account

Make sure your main Google Cloud account (the one you'll log in with) has these roles:

  • Owner
  • Service Usage Admin
  • Service Usage Consumer

3. 🧭 Create OAuth Credentials (for Google Drive Access)

Still in the Google Cloud Console:

  • Go to APIs & Services → Credentials → + Create Credentials → OAuth Client ID
  • If prompted, configure the OAuth consent screen:
    • Choose Desktop App
    • Provide a name (e.g., "Drive Access")
  • Once created:
    • Download the JSON file (this is your OAuth credentials)
    • Save the client_id and client_secret (you’ll use these in your config)

4. 🚀 Enable Required APIs

In the left-hand menu:

  • Go to APIs & Services → Library
  • Enable the following APIs:
    • Google Drive API
    • Google Earth Engine API

5. 👤 Add Test Users (Required for OAuth)

  • Go to APIs & Services → OAuth consent screen
  • Scroll to the Test Users section
  • Click + Add Users and add your personal Google account (the one you'll use for authentication)

Install Instructions

For the stable build:

pip install ee-wildfire

For the experimental build:

git clone git@github.com:KylesCorner/Earth-Engine-Wildfire-Data.git
cd Earth-Engine-Wildfire-Data
pip install -e .

Configuration

Template for configuration:

project_id: YOUR PROJECT ID # google cloud api project id for earth engine
data_dir: ~/ee_wildfire_data/ # Directory to store all the data for this program.
year: '2021' # year to batch
month: '1'
min_size: 10_000_000 # minimum size of fire image
download: false # flag to download data?
export: false # flag to export data?
force_new_geojson: false # some times when attempting to export large amounts of data it fails and corrupts the geojson param file. This regenerates it.

To finish configuration you will need to use the -config command line argument.

Command-Line Interface (CLI)

Argument Description
-config PATH Loads a YAML config file located at PATH.
-show-config Prints current config to command line.
-export Export data from Google Earth Engine to Google Drive.
-download Downloads data from Google Drive to your local machine.
-force-new-geojson Forces the creation of new geojson fire parameters.

Basic Usage

ee-wildfire -config /path/to/some/config.yml -show-config
ee-wildfire -force-new-geojson -export -download

Acknowledgements

This project builds on work from the WildfireSpreadTSCreateDataset. Credit to original authors for providing data, methods, and insights.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ee_wildfire-2025.1.4.tar.gz (126.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ee_wildfire-2025.1.4-py3-none-any.whl (133.4 kB view details)

Uploaded Python 3

File details

Details for the file ee_wildfire-2025.1.4.tar.gz.

File metadata

  • Download URL: ee_wildfire-2025.1.4.tar.gz
  • Upload date:
  • Size: 126.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for ee_wildfire-2025.1.4.tar.gz
Algorithm Hash digest
SHA256 300d3c45ba535e3e29cad2b489119da5a290259409f051f79861c10263c50da8
MD5 3a0abb19efc05605a1bb9bf34cf1b6b3
BLAKE2b-256 6e4f3fa555e6540bb1144a9f96555fe3ee2a55a84c9a63bb4ff6d68f79f8efd6

See more details on using hashes here.

File details

Details for the file ee_wildfire-2025.1.4-py3-none-any.whl.

File metadata

  • Download URL: ee_wildfire-2025.1.4-py3-none-any.whl
  • Upload date:
  • Size: 133.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for ee_wildfire-2025.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b8256d16496b98ebd160cfc029393aad8a573c5d4683082dc37a66a1ea6c2948
MD5 d93afec3511398be8a9acae796fbc64a
BLAKE2b-256 7ab291aba89653cea2ebb276d68d1b032929733e6fa4501954a8073c5511a686

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page