{"id":13949004,"url":"https://github.com/kleok/FLOODPY","last_synced_at":"2025-07-20T11:30:45.384Z","repository":{"id":37487458,"uuid":"378998906","full_name":"kleok/FLOODPY","owner":"kleok","description":"Flood Python Toolbox","archived":false,"fork":false,"pushed_at":"2024-10-26T21:06:07.000Z","size":301039,"stargazers_count":182,"open_issues_count":1,"forks_count":33,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-06-22T18:03:19.153Z","etag":null,"topics":["flood","flood-monitoring","floods","python","remote-sensing","sentinel-1","surface-water","synthetic-aperture-radar"],"latest_commit_sha":null,"homepage":"https://floodpy.readthedocs.io/en/latest/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kleok.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-21T16:42:00.000Z","updated_at":"2025-06-04T17:06:03.000Z","dependencies_parsed_at":"2024-11-07T01:50:37.435Z","dependency_job_id":null,"html_url":"https://github.com/kleok/FLOODPY","commit_stats":{"total_commits":421,"total_committers":9,"mean_commits":46.77777777777778,"dds":"0.18289786223277915","last_synced_commit":"f7c51afab737e0f38de560e2067f0c7acfd28d03"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/kleok/FLOODPY","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleok%2FFLOODPY","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleok%2FFLOODPY/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleok%2FFLOODPY/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleok%2FFLOODPY/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kleok","download_url":"https://codeload.github.com/kleok/FLOODPY/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kleok%2FFLOODPY/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262327265,"owners_count":23294241,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flood","flood-monitoring","floods","python","remote-sensing","sentinel-1","surface-water","synthetic-aperture-radar"],"created_at":"2024-08-08T05:01:36.131Z","updated_at":"2025-07-20T11:30:45.351Z","avatar_url":"https://github.com/kleok.png","language":"Jupyter Notebook","funding_links":[],"categories":["Climate Change"],"sub_categories":["Natural Hazard and Storms"],"readme":"# \u003cimg src=\"https://github.com/kleok/FLOODPY/blob/main/figures/Floodpy_logo.png\" width=\"58\"\u003e FLOODPY - FLOOD PYthon toolbox \n[![GitHub license](https://img.shields.io/badge/License-GNU3-green.svg)](https://github.com/kleok/FLOODPY)\n[![Release](https://img.shields.io/badge/Release-Floodpy_Oct_2024-brightgreen)](https://github.com/kleok/FLOODPY)\n[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/kleok/FLOODPY/issues)\n[![Documentation](https://readthedocs.org/projects/floodpy/badge/?version=latest)](https://floodpy.readthedocs.io/en/latest/)\n\n## Introduction\n\nThe Flood mapping python toolbox (Floodpy) is a free and open-source python toolbox for mapping the non-urban flooded regions. It exploits the dense Sentinel-1 GRD intensity time series using a statistical or a ViT (Visual Transfomer) approach. Before running Floodpy make use you know the following information of the flood event of your interest\n - Date and time of the flood event\n - Spatial information (e.g. min,max latitude and min,max longitude) of the flood event\n\nThis is research code provided to you \"as is\" with NO WARRANTIES OF CORRECTNESS. Use at your own risk.\n\n\u003cimg src=\"https://github.com/kleok/FLOODPY/blob/main/figures/pinieios_results_github.png\" width=\"900\"\u003e\n\n## 1. Installation\n\nThe installation notes below are tested only on Linux. \nRecommended setup: Python 3.9+, SNAP 9.0+\n\n### 1.1 Install snap gpt including Sentinel-1 toolbox\n\nPlease download ESA-SNAP (All Toolboxes) from [here](https://step.esa.int/main/download/snap-download/) and install it using the following commands:\n\n  ```bash\n  chmod +x esa-snap_all_linux-10.0.0.sh\n  ./esa-snap_all_linux-10.0.0.sh\n  ```\n\n### 1.2 Account setup for downloading Sentinel-1 acquisitions\n\nEven though we offer credentials (for demonstration reasons), we encourage you\nto create your own account in order to not encounter any problems due to\ntraffic.\n\n- Please create an account at: [Copernicus-DataSpace](https://dataspace.copernicus.eu/).\n\n### 1.3 Account setup for downloading global atmospheric model data\n\nFloodPy can download meteorological data from based on ERA-5 data. \nYou have to create a new account [here](https://cds.climate.copernicus.eu/) if you don't own a user account yet. \nAfter the creation of your profile, you will find your Personal Access Token on your User profile page. \nCreate manually a ```.cdsapirc``` file  under your ```HOME``` directory with the following information:\n\n```\nurl: https://cds.climate.copernicus.eu/api\nkey: Your Personal Access Token\n```\n\n### 1.4 Download FLOODPY\n\nYou can download FLOODPY toolbox using the following command:\n```git clone https://github.com/kleok/FLOODPY.git```\n\n### 1.5 Create python environment for FLOODPY\n\nFLOODPY is written in Python3 and relies on several Python modules. We suggest to install them by using conda.\n\n- Using **conda**\nCreate a new conda environement with required packages using the the file [FLOODPY_gpu_env.yml](https://github.com/kleok/FLOODPY/blob/main/FLOODPY_gpu_env.yml).\n\n```\nconda env create -f path_to_FLOODPY/FLOODPY_gpu_env.yml\n```\n\n### 1.6 Set environmental variables (Optional)\n\nAppend to .bashrc file\n```\nexport FLOODPY_HOME= path_of_the_FLOODPY_folder\nexport PYTHONPATH=${PYTHONPATH}:${FLOODPY_HOME}\nexport PATH=${PATH}:${FLOODPY_HOME}/floodpy\n```\n\n## 2. Running FLOODPY\n\nFLOODPY generates a map with flooded regions based on Sentinel-1 GRD products and meteorological data. \nSentinel-1 orbits are downloaded using the [sentineleof](https://github.com/scottstanie/sentineleof)\nYou can run FLOODPY using the following jupyter notebooks as templates.\n\n- [Floodpy statistical approach](https://nbviewer.org/github/kleok/FLOODPY/blob/main/Floodpyapp_stat.ipynb)\n- [Floodpy deep learning approach](https://nbviewer.org/github/kleok/FLOODPY/blob/main/Floodpyapp_Vit.ipynb)\n\n## 3. Documentation and citation\nAlgorithms implemented in the software are described in detail at our publications. If FLOODPY was useful for you, we encourage you to cite the following work: \n- Karamvasis K, Karathanassi V. FLOMPY: An Open-Source Toolbox for Floodwater Mapping Using Sentinel-1 Intensity Time Series. Water. 2021; 13(21):2943. https://doi.org/10.3390/w13212943 \n\n- Kuro Siwo: 33 billion m2 under the water. A global multi-temporal satellite dataset for rapid flood mapping. https://paperswithcode.com/paper/kuro-siwo-12-1-billion-m-2-under-the-water-a\n\nYou can also have a look at other works that are using FLOODPY:\n\n- Gounari 0., Falagas A., Karamvasis K., Tsironis V., Karathanassi V., \nKarantzalos K.: Floodwater Mapping \u0026 Extraction of Flood-Affected \nAgricultural Fields. Living Planet Symposium Bonn 23-27 May 2022.      \nhttps://drive.google.com/file/d/1HiGkep3wx45gAQT6Kq34CdECMpQc8GUV/view?usp=sharing\n\n- Zotou I., Karamvasis K., Karathanassi V., Tsihrintzis V.: Sensitivity of a coupled 1D/2D \nmodel in input parameter variation exploiting Sentinel-1-derived flood map. \n7th IAHR Europe Congress. September 7-9, 2022. Page 247 at \nhttps://www.iahreuropecongress.org/PDF/IAHR2022_ABSTRACT_BOOK.pdf\n\n- Zotou I, Karamvasis K, Karathanassi V, Tsihrintzis VA. Potential of Two SAR-Based Flood Mapping Approaches in Supporting an Integrated 1D/2D HEC-RAS Model. Water. 2022; 14(24):4020. https://doi.org/10.3390/w14244020 \n\n## 4. Contact us\nFeel free to open an issue, comment or pull request. We would like to listen to your thoughts and your recommendations. Any help is very welcome! :heart:","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkleok%2FFLOODPY","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkleok%2FFLOODPY","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkleok%2FFLOODPY/lists"}