Skip to main content

No project description provided

Project description

s1flood

Google Earth Engine (GEE) flood algorithm as described in DeVries et al., Remote Sensing of Environment (2020).

An account on the GEE is required to use s1flood. To sign up for an account, go to https://earthengine.google.com.

1. On the GEE Playground

Load the repository by including the following line in your script:

var s1flood = require('users/bdv/s1flood');

Specific scripts (functions) can be accessed as follows:

var zscore = require('users/bdv/s1flood:zscore');
var mapFloods = require('users/bdv/s1flood:mapFloods');

Examples

Summary stats demo: https://code.earthengine.google.com/fe91cf1ab5df51fe107dd9b07f84835a

Houston (Hurricane Harvey), 2017-08-30: https://code.earthengine.google.com/5ff925dd39ac4a1994719bb4f7681940

Beira, Mozambique (Cyclone Idai), 2018-03-23: https://code.earthengine.google.com/444cf654636f01877875721c9c402c7c

The Bahamas (Hurricane Dorian), 2019-09-04: https://code.earthengine.google.com/29e799edb05ab69e11dfa3bd14146e33

Omaha, Nebraska, 2019-03-25: https://code.earthengine.google.com/5bdf08bae781e45564bc8c6b31d4067e

Central Greece, 2018-03-01: https://code.earthengine.google.com/3ee7b5408c7a7aa1ee13988afa6236c9

2. Python Package

To install the s1flood python package into a conda environment:

conda create -n ee python earthengine-api
conda activate ee

You will need to authrorize use of your GEE account the first time you load and inialize the ee module:

python -c "import ee; ee.Initialize()"

Follow the instructions after running this code.

Finally, install s1flood using pip.

pip install s1flood

Using DSWE

In addition to using Sentinel-1 backscatter anomalies (Z-scores) to map floods, Landsat data are used to map historical inundation and permanent open water. Two options are avialable for the historical inundaiton and permanent open water mapping:

  1. Exclusive use of the JRC Global Surface Water (GSW) dataset. Two probability thresholds are applied: 90% for permanent open water and 25% for seasonal inundation.
  2. Combined use of the JRC-GSW and the Dynamic Surface Water Extent (DSWE). The two thresholds described in (1) are applied to both datasets to define permanent open water and seasonal inundation.

Option (1) is used by default, and Option (2) is triggered by the use_dswe argument in the mapFloods() function. Use of this option requires installation of the eedswe package, available here. mapFloods() will default to Option (1) with a warning if eedswe is not installed and use_dswe is True.

Examples

Some example notebooks are included in the "examples/" directory. To run these, you also need to install geemap, matplotlib, pandas and jupyter:

conda install geemap matplotlib pandas jupyter
jupyter notebook

Reference

DeVries, B., Huang, C-Q., Armston, J. Huang, W., Jones, J.W. and Lang M.W. 2020. Rapid and robust monitoring of floods using Sentinel-1 and Landsat data on the Google Earth Engine. Remote Sensing of Environment, 24:111664, doi:10.1016/j.rse.2020.111664.

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

s1flood-0.0.3.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

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

s1flood-0.0.3-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file s1flood-0.0.3.tar.gz.

File metadata

  • Download URL: s1flood-0.0.3.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0.post20200209 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.1

File hashes

Hashes for s1flood-0.0.3.tar.gz
Algorithm Hash digest
SHA256 aa805d34e987f0d63a5e30a09b454de1cc252a26c885b16e4da112883e9ab0c5
MD5 e626379fef5ab60c92467f7ecf7bfd87
BLAKE2b-256 5955d862a8b762abe912ac772215c19477709a955c984d32e977bb8095e3194b

See more details on using hashes here.

File details

Details for the file s1flood-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: s1flood-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0.post20200209 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.1

File hashes

Hashes for s1flood-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 44862a2310750cc534aced8896c9e12c0cbdfda686c0722215a94715dd72ef3e
MD5 22ab18a1e670f480c946cafdff110a89
BLAKE2b-256 6e9a8d48f7d914ee0629805449e72487fc97ef27745dbac1f18ff20b28b84028

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