Skip to main content

Dynamic Flood Simulations

Created in collaboration with Northeastern University

Overview

This end-to-end dynamic flood simulation is intended for use with the Analytics workflow in UVDAT (Urban Visualization and Data Analysis Toolkit). This module consists of three parts: downscaling prediction, hydrological prediction, and hydrodynamic prediction.

Explanation

First, an AI downscaling model uses regional climate projections to determine future local precipitation conditions, such as the intensity of extreme rainstorms. These extreme precipitation levels are fed into a hydrological model, which uses precipitation and evapotranspiration to determine runoff and discharge. Finally, a hydrodynamic model uses discharge to map flood depth over time.

This is a proof of concept for the Charles River in Boston that could be translated to other rivers and cities. The user selects the inputs described below, and the output is a flood simulation, represented as a multiframe stacked GeoTIFF raster, a time-varying map of flood depth with one frame per hour for 24 hours.

Inputs

  1. Time Period: the 20 year time period in which to predict a flood. Options are "2031-2050" and "2041-2060" (the former is the default).

  2. Annual Probability: the probability that a flood of this magnitude will occur in any given year. This value must be greater than 0 and less than 1. The default is 0.04, which represents a 1 in 25 year flood.

  3. Hydrograph: a list of proportions that sum to 1; these represent fractions of the total rainfall volume per timestep. This may also be specified as Hydrograph Name, where options include "short_charles" and "long_charles", which represent premade hydrograph data. The former is the default.

  4. Potential Evapotranspiration Percentile: Select the percentile value for potential evapotranspiration

  5. Soil Moisture Percentile: Select the percentile value for soil moisture

  6. Ground Water Percentile: Select the percentile value for ground water

  7. Initial Condition Set: Initial conditions "001", "002", and "003" start real-world emissions from year 1850 with the climate state from the 1001st, 1021st, and 1041st year of a pre-industrial control simulation. Since Earth's climate undergoes multi-year and multi-decadal cycles, the different initializations reveal the range of possible climates in real-world years 2031 and beyond.

Installation

pip install uvdat-flood-sim

Example usage

To run a flood simulation with default inputs:

python -m uvdat_flood_sim

To see the help menu explaining how to use arguments to specify input values:

python -m uvdat_flood_sim --help

Viewing Results

By default, results will be displayed with a matplotlib animation. This animation is saved in the outputs folder as animation.gif. Results are also saved in the outputs folder as a multiframe geospatial tiff called flood_simulation.tif, which can be added to UVDAT for visualization.

Metadata

Release files for uvdat-flood-sim 1.0.5

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

Source distribution (sdist)

Source distribution for uvdat-flood-sim 1.0.5
File Size Uploaded
uvdat_flood_sim-1.0.5.tar.gz 19.1 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for uvdat-flood-sim 1.0.5
File Interpreter ABI Platform
uvdat_flood_sim-1.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 38.3 MB

Release files / uvdat_flood_sim-1.0.5.tar.gz

Download URL uvdat_flood_sim-1.0.5.tar.gz
Size 19.1 MB
Tags Source
SHA-256 checksum
How to use checksums
7db98a24c36904e2ae68fb3f08a44be5228efcfb943eebe32d326ffbdadb20c7
BLAKE2b-256 checksum
How to use checksums
1e4826bd975c63284fe82b3865b1248bb75db27e296907cd6d250b1f9d5cd4bf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 21, 2026.

Transparency log

Release files / uvdat_flood_sim-1.0.5-py3-none-any.whl

Download URL uvdat_flood_sim-1.0.5-py3-none-any.whl
Size 19.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
453d2c46b5750234fc63b872ad05bf776cb62781088b81631b62381dd8c0c812
BLAKE2b-256 checksum
How to use checksums
30fbc25255ee613455c487fc981ed80c6c6c05174c68a0d606b4ad895ef67088
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 21, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.0.5 This release

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

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