Flood App is a RESTful web service that integrates with the Fora.ai platform to support participatory watershed modeling. Built on Landlab, the service performs watershed-scale simulations of surface runoff and soil infiltration based on user-defined landscape conditions and mitigation interventions.
Community users interact through the Fora.ai platform to design modeling scenarios that incorporate mitigation measures such as berms and mulch. Fora.ai sends GeoJSON-based map data to Flood App through a REST API, where the inputs are translated into physics-based simulations using Landlab components. Simulations are executed asynchronously and the results are returned to Fora.ai for visualization, scenario comparison, and decision support.
Clone the repository, install dependencies with conda, then install the package:
git clone https://github.com/gantian127/flood_app
cd flood_app
conda install --file=requirements.txt -c conda-forge
pip install -e .Start the server:
start-app --port=80 --host=0.0.0.0Please read the Full documentation for detailed information about Flood App.
For the API specification including request/response formats and examples, see the API Documentation.
Contributions are welcome! Please read CONTRIBUTING for guidelines on reporting issues and submitting pull requests.
MIT — see LICENSE for details.
If you use Flood App in your research, please cite it using the metadata in CITATION.cff or via the GitHub "Cite this repository" button.
See CREDITS for the list of contributors and acknowledgments.