hydra-floods

unittests

Introduction

The Hydrologic Remote Sensing Analysis for Floods (or HYDRAFloods) is an open source Python application for downloading, processing, and delivering surface water maps derived from remote sensing data. The bases behind the tool is to provide sensor agnostic approaches to produce surface water maps. Furthermore, there are workflows that leverage multiple remote sensing dataset in conjunction to provide daily surface water maps for flood application.

Installation

The recommended way to get up and started using the hydrafloods packages is to install using pip:

pip install hydrafloods

pip should handle some of the basic dependencies such as the Earth Engine Python API that we need for the majority of the functionality. It is planned to add hydrafloods to the conda-forge channel but that is currently not completed.

To use the hydrafloods package successfully, Google Cloud and Earth Engine authentication is necessary. Tointialize the Google Cloud environment and authenticate using your credentials, run the following command:

gcloud init

To authenticate the Earth Engine Python API with your credentials, run the following:

earthengine authenticate

For more information on setup and installation of the hydrafloods package, please see the Installation Docs.

Example

To highlight a quick example of the hydrafloods API and simplicity to produce high-quality surface water maps we provide a quick example of mapping surface water using Sentinel-1 over the confluence of the Mekong and Tonle Sap rivers, which experiences frequent flooding.

# import the hydrafloods and ee package
import hydrafloods as hf
import ee
ee.Initialize()

# specify start and end time as well as geographic region to process
start_time = "2019-10-05"
end_time =  "2019-10-06"
region = ee.Geometry.Rectangle([104, 11.5, 106, 12.5 ])

# get the Sentinel-1 collection
# the hf.dataset classes performs the spatial-temporal filtering for you
s1 = hf.datasets.Sentinel1(region, start_time, end_time)

# apply a water mapping function to the S1 dataset
# this applies the "Edge Otsu" algorithm from https://doi.org/10.3390/rs12152469
water_imgs = s1.apply_func(
    hf.thresholding.edge_otsu,
    initial_threshold=-14,
    thresh_no_data=-20,
    edge_buffer=300
)

# take the mode from multiple images
# since this is just imagery from one day, it will simply mosaic the images
water_map = ee.Image(water_imgs.collection.mode())

# export the water map
hf.geeutils.export_image(
    water_map,
    region,
    "users/<YOUR_USERNAME>/water_map_example",
    scale=30,
)

(This script is complete, it should run "as is")

At the end of the script execution, there will be an Earth Engine export task running the process on the EE servers for use later in the EE platform. The resulting surface water image should look like the following figure. It should be noted that hydrafloods can scale quickly and easily by simply changing the start or end time and region to process, allowing for processing of surface water maps with minimal effort in terms of coding.

Quick Start Results

__Figure 1.__ Sentinel-1 backscatter image (left) and resulting surface water map (right) from 2019-10-05 for a region in Cambodia as in the example.

Learn more about the package throughout the documentation such as installation, the algorithms available, or setting up the package to run operationally using the CLI.

Get in touch

Report bugs, suggest features or view the source code on GitHub.
Contact us through a Technical Assistance Request and mention "hydrafloods"

Contribute

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. Please see the Contributing Guidelines for details on where to contribute and how to get started.

License

hydrafloods is available under the open source GNU General Public License v3.0.

Metadata

Release files for hydrafloods 2023.10.14

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

Source distribution (sdist)

Source distribution for hydrafloods 2023.10.14
File	Size	Uploaded
hydrafloods-2023.10.14.tar.gz	79.2 kB	Oct 14, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for hydrafloods 2023.10.14
File	Interpreter	ABI	Platform	Reset
hydrafloods-2023.10.14-py3-none-any.whl 86.6 kB Oct 14, 2023	Python 3	none	any	Details

Total release size: 165.8 kB

Release files / hydrafloods-2023.10.14.tar.gz

Download URL	hydrafloods-2023.10.14.tar.gz
Size	79.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`50bebf9760c526481305389ea8f262b37b61c0d92ed647a72f05ab789b91f7f2`
BLAKE2b-256 checksum How to use checksums	`b5b5d40aab9ccbf5faa5346e0ff112081e947a2fd8f3381da76fee17ca26156c`
Upload date	Oct 14, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.5`

Release files / hydrafloods-2023.10.14-py3-none-any.whl

Download URL	hydrafloods-2023.10.14-py3-none-any.whl
Size	86.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`85a41237f12b231c7664b99b70e51efd5f54a3289c31c10cf3430eee7e3d9b8c`
BLAKE2b-256 checksum How to use checksums	`0e1e345abb242553f3a03e246a2ce3d53a281b9e4947236cf149f099d3f6ef41`
Upload date	Oct 14, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.5`