Skip to main content

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

Project description

wildfire-analyser

Python project for analyzing wildfires in natural reserves.

Installation and Usage

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

mkdir /tmp/test
cd /tmp/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 two items:


1. Add a GeoJSON polygon

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

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

An example GeoJSON file is available in the repository.


2. Create the .env file with GEE authentication data

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

A .env template is also available in the GitHub repository.

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

Running the Client

After adding the .env file and your GeoJSON polygon:

python3 -m wildfire_analyser.client --roi polygons/eejatai.geojson --start-date 2024-09-01 --end-date 2024-11-08

This will start the analysis process, generate the configured deliverables, and save the output files in the current directory.

Setup Instructions for Developers

  1. Clone the repository
git clone git@github.com:camargo-advanced/wildfire-analyser.git
cd wildfire-analyser
  1. Create a virtual environment
python3 -m venv venv
  1. Activate the virtual environment
source venv/bin/activate
  1. Install dependencies Make sure the virtual environment is activated, then run:
pip install -r requirements.txt
  1. Configure environment variables Copy your version of .env file to the root folder with your GEE authentication credentials. A template file .env.template is provided as an example.

  2. Run the sample client application

python3 -m wildfire_analyser.client

Useful Commands

  • Deactivate the virtual environment:
deactivate

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.4.tar.gz (11.9 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.4-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wildfire_analyser-0.2.4.tar.gz
  • Upload date:
  • Size: 11.9 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.4.tar.gz
Algorithm Hash digest
SHA256 aa7387267c6e79bb8f287346823703e6b7458e4c662baf23b20b1e2f5a4eb2e3
MD5 a6e2ed0624aaa60397698e4e6dd962e0
BLAKE2b-256 d7a2e9e39429d62a1b6e763c738155db55c47d0ec159565457f538e5f0a09756

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wildfire_analyser-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cfe40ccfcea2210e5851321bbef698dadafe908c9155034e7c9a3c9febead0a8
MD5 ead725cb803b9e594460c9f8176e01e3
BLAKE2b-256 9458dc6ab771247bcb4469e99a3ca8e01e11b24c36b4c75f8528d1c5ea9bab02

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