Skip to main content

HYDrologic Remote sensing Analysis for Floods

Project description

hydra-floods

docs

Introduction

HYDrologic Remote sensing Analysis for Floods (HydraFloods) is a Python application for downloading, processing, and delivering flood maps derived from remote sensing data. This is backend behind the HYDRAViewer Geospatial tool which utilizes many remote sesnsing dataset as possible to provide daily (sometime twice daily) flood maps.

hydrafloodviewer

IMAGE ALT TEXT HERE

Installation

  1. Create a new conda environment with the required dependencies and activate the environment
$ conda create -n hydra -c conda-forge python=3.6 numpy scipy pandas requests yaml xmltodict gdal shapely pyproj netCDF4 xarray pyresample geopandas earthengine-api fire

$ conda activate hydra
  1. Install additional packages via pip that are not on conda-forge
$ pip install git+git://github.com/KMarkert/simple-cmr.git
  1. Authenticate the Earth Engine API
$ earthengine authenticate
  1. Install Google Storage Utility command-line interface (gsutil) and the setup the gsutil environment
$ gcloud init

$ gcloud auth application-default login

NOTE:

Make sure your initialize the ee and gsutil APIs with Google accounts that have permissions to read and write to Google Cloud Storage and Google Earth Engine assets.


  1. Download the hydrafloods source code and install the package
  • COMING SOON: the hydrafloods package will be on PyPI in the near future to prevent installing from source
$ git clone https://github.com/servir-mekong/hydra-floods.git
$ cd hydra-floods/py pkg
$ python setup.py install
  1. Test to see if the installation was successful
$ hydrafloods run_tests

How-to

To initiate the HydraFloods process use the command below.

$hydrafloods process atms 2015-07-19 --configuration myconf.yaml

NOTE: Details regarding the command

  • hydrafloods --- call the hydrafloods process to begin

  • process --- start the hydraflood process

  • atms --- specify sensor (see processing.py for details options include: Sentinel2, Landsat, Modis, Viirs, Atms, Sentinel1)

  • 2015-07-19 --- specify the date of intrest

  • --configuration --- use the configuration file

  • myconf.yaml --- call the .yaml file that specifies the ROI etc. (see the exampl.yaml for details)

config example

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

hydrafloods-0.1.0.tar.gz (32.6 kB view details)

Uploaded Source

Built Distribution

hydrafloods-0.1.0-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

Details for the file hydrafloods-0.1.0.tar.gz.

File metadata

  • Download URL: hydrafloods-0.1.0.tar.gz
  • Upload date:
  • Size: 32.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.10

File hashes

Hashes for hydrafloods-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fb5070927dbcc25816129fbee63d1796f9d4c7994c56e1c88e6523f65cbff8ba
MD5 935403fccb88a9fad89f0023fe6a4787
BLAKE2b-256 21e38566b23fc8177e014cc58a48511fd12ea82b5ebd34d51a879f9eebcd00b1

See more details on using hashes here.

File details

Details for the file hydrafloods-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hydrafloods-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 38.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.10

File hashes

Hashes for hydrafloods-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9298e467b0cb928eac7cecb810c44b55106522fe8bda7d3d10a5df771fb10939
MD5 1fdbda94a495850edf655283ee9f9c27
BLAKE2b-256 ae762eb8f6cb4f28a6a3254a7faa07c3993af4551347656222ee49a09204c730

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page