Skip to main content

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.

Metadata

Release files for s1flood 0.0.3

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

Source distribution (sdist)

Source distribution for s1flood 0.0.3
File Size Uploaded Provenance Actions
s1flood-0.0.3.tar.gz 5.2 kB Without provenance Details for s1flood-0.0.3.tar.gz

Built distribution (wheel)

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

Total release size: 11.5 kB

Release files / s1flood-0.0.3.tar.gz

Download URL s1flood-0.0.3.tar.gz
Size 5.2 kB
Tags Source
SHA-256 checksum
How to use checksums
aa805d34e987f0d63a5e30a09b454de1cc252a26c885b16e4da112883e9ab0c5
BLAKE2b-256 checksum
How to use checksums
5955d862a8b762abe912ac772215c19477709a955c984d32e977bb8095e3194b
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / s1flood-0.0.3-py3-none-any.whl

Download URL s1flood-0.0.3-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
44862a2310750cc534aced8896c9e12c0cbdfda686c0722215a94715dd72ef3e
BLAKE2b-256 checksum
How to use checksums
6e9a8d48f7d914ee0629805449e72487fc97ef27745dbac1f18ff20b28b84028
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for s1flood 0.0.3

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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