Skip to main content

Python library for post-fire assessment and wildfire analysis using Google Earth Engine.

Project description

Project Architecture (Overview)

The wildfire-analyser project is organized into three conceptual layers:

  • Core library (fire_assessment)
    Implements scientific computation, dependency resolution, and Earth Engine logic.

  • Execution layer (DAG)
    Automatically resolves and executes dependencies required for each deliverable.

  • Command-line interfaces (CLI)
    User-facing tools for running analyses and monitoring Earth Engine tasks.

Outputs

All generated outputs (GeoTIFFs, thumbnails, statistics) are considered runtime artifacts and are not committed to version control.

Scientific Background

This project is based on the peer-reviewed study:

Spatial and statistical analysis of burned areas with Landsat-8/9 and Sentinel-2 satellites: 2023 Çanakkale forest fires Authors: Deniz Bitek, Fusun Balik Sanli, Ramazan Cuneyt Erenoglu Study area: Çanakkale Province, Turkey

The methodology implemented in wildfire-analyser follows the same analytical framework and burn severity thresholds described in the paper, particularly for the Sentinel-2–based analysis, including:

  • dNBR, dNDVI and RBR indices
  • Burn severity classification tables
  • Area statistics in hectares and percentage

Minor numerical differences may occur due to cloud masking, spatial sampling, and Google Earth Engine implementation details.


Installation and Usage

Follow the steps below to install and test wildfire-analyser inside an isolated environment:

mkdir test
cd test

python3 -m venv venv
source venv/bin/activate

pip install wildfire-analyser

Required Files Before Running the Client

Before running the client, you must prepare the following items:


1. Add a GeoJSON polygon (ROI)

Create a folder named polygons in the project root and place your ROI polygon file inside it:

/tmp/test/
├── polygons/
│   └── your_polygon.geojson
└── venv/

Example GeoJSON files are available in the repository (e.g. canakkale_aoi_1.geojson).


2. Create the .env file with GEE credentials

In the project root, add a .env file containing your Google Earth Engine authentication variables.

A .env.template file is available in the repository.

/tmp/test/
├── .env
├── polygons/
└── venv/

Running the Client (Standard Mode)

After adding the .env file and your GeoJSON polygon:

python3 -m wildfire_analyser.cli \
  --roi polygons/canakkale_aoi_1.geojson \
  --start-date 2023-07-01 \
  --end-date 2023-07-21 \
  --deliverables \
    DNBR_VISUAL \
    DNDVI_VISUAL \
    RBR_VISUAL \
    DNBR_AREA_STATISTICS \
    DNDVI_AREA_STATISTICS \
    RBR_AREA_STATISTICS \
  --days-before-after 1

This will:

  • Run the post-fire assessment pipeline
  • Generate visual thumbnail URLs
  • Generate scientific GeoTIFF outputs (when applicable)
  • Compute burned area statistics
  • Print all results to the terminal

Deliverables

You may explicitly select deliverables using --deliverables.

Scientific products

  • RGB_PRE_FIRE
  • RGB_POST_FIRE
  • NDVI_PRE_FIRE
  • NDVI_POST_FIRE
  • NBR_PRE_FIRE
  • NBR_POST_FIRE
  • DNDVI
  • DNBR
  • RBR

Visual products

  • RGB_PRE_FIRE_VISUAL
  • RGB_POST_FIRE_VISUAL
  • DNDVI_VISUAL
  • DNBR_VISUAL
  • RBR_VISUAL

Severity maps and statistics

  • DNBR_AREA_STATISTICS
  • DNDVI_AREA_STATISTICS
  • RBR_AREA_STATISTICS

Example:

python3 -m wildfire_analyser.cli \
   --roi polygons/canakkale_aoi_1.geojson \
   --start-date 2023-07-01 \
   --end-date 2023-07-21 \
   --deliverables DNBR_VISUAL DNBR_AREA_STATISTICS \
   --days-before-after 1

If --deliverables is not provided, all available deliverables are generated.


Paper Preset Mode (Reproducibility)

The client also supports paper presets, which are predefined experimental configurations designed to reproduce published results.

Example preset: PAPER_DENIZ_FUSUN_RAMAZAN

Run:

python3 -m wildfire_analyser.cli \
  --deliverables PAPER_DENIZ_FUSUN_RAMAZAN

This preset:

  • Executes the analysis for two distinct burned areas
  • Uses paper-aligned temporal windows
  • Generates only visual outputs and statistics
  • Does not export scientific GeoTIFFs
  • Prints results grouped by area

Internally, it runs:

Area ROI Pre-fire Post-fire
Area 1 canakkale_aoi_1.geojson 2023-07-01 2023-07-21
Area 2 canakkale_aoi_2.geojson 2023-07-31 2023-08-30

Help

For help and full usage information:

python3 -m wildfire_analyser.cli --help

Additional Documentation

The following documents provide more detailed and advanced guidance for development, environment setup, and asynchronous processing workflows. They are not required if the environment is already configured, but are recommended for first-time setup, developers, and production deployments.

  • Development Guide Internal architecture, project conventions, and contribution guidelines. docs/development.md

  • Environment & Credentials Setup Step-by-step instructions for configuring Google Earth Engine, service accounts, environment variables, and Cloud Storage. docs/environment-setup.md

  • 🔧 Asynchronous GEE Task Monitoring Detailed explanation of asynchronous scientific exports, gee_task_id handling, and task monitoring using the standalone CLI tool. docs/gee_task_monitoring.md


When to read these documents

  • Read environment-setup.md before running the pipeline in a new system.
  • Read gee_task_monitoring.md when integrating with frontend/backend architectures or background workers.
  • Read development.md if you plan to modify or extend the codebase.

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

wildfire_analyser-0.2.14.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

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

wildfire_analyser-0.2.14-py3-none-any.whl (38.1 kB view details)

Uploaded Python 3

File details

Details for the file wildfire_analyser-0.2.14.tar.gz.

File metadata

  • Download URL: wildfire_analyser-0.2.14.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for wildfire_analyser-0.2.14.tar.gz
Algorithm Hash digest
SHA256 0b88b02c82719bb16157c3ae28ed884adc6c88e152d981501a402821454be01f
MD5 4df93a81d55d40e2b85c61eb750bc431
BLAKE2b-256 a79f9c55882c0a1e9fafbf20d334c6a997d011e37d50255bebe8c146438e3c1f

See more details on using hashes here.

File details

Details for the file wildfire_analyser-0.2.14-py3-none-any.whl.

File metadata

File hashes

Hashes for wildfire_analyser-0.2.14-py3-none-any.whl
Algorithm Hash digest
SHA256 ae8277d332288bc9dc2f3141c19d11b6b4cf4412b62648edc5e6dad40ab990b4
MD5 a416e64cd8c149aa9fdbdbb37e016cf3
BLAKE2b-256 ad5ef68ccc167ca9724c7f397d29d445fb0eb49c076b0404b4b0116f2f754459

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