This release is a pre-release and may not be stable for production use.
AutoFloods is a Python package for automated flood mapping at scale from Sentinel-1 SAR imagery, with pluggable data sources (Microsoft Planetary Computer, NASA OPERA) and detection methods (Z-score, Otsu).
Quickstart
OPERASource requires a free NASA Earthdata Login; MPCSource works with no credentials at all (a free subscription key just raises rate limits) — see Authentication.
Pre-release: pip install --pre autofloods
Basic usage:
from autofloods import flood_mapper
from autofloods.sources import OPERASource
fm = flood_mapper(
# AOI grid; needs id_col, dry_date_col, zone columns
grid_shapefile='resources/india_utm_fishnet_buffer.gpkg',
# which AOI IDs from the grid to process
grid_id_list=[321],
# dry-season years to build the baseline from
dry_years=[2024, 2024],
# where the terrain-slope mask is cached
slope_dir='resources/slope/',
# wet-season date range to classify
wet_duration=['2024/07', '2024/10'],
# or MPCSource() (the default)
source=OPERASource(),
# root dir for all outputs and caches
output_dir='output/my_run',
)
# read each AOI's dry season into self.dry_months
fm.get_dry_dates()
# turn dry_months into per-year search date ranges
fm.generate_dry_date_ranges()
# STAC-search the source for dry-season scenes
fm.get_s1_items(dry_wet='dry')
# download + read those scenes
fm.read_scenes(dry_wet='dry', overview_level=None, max_workers=6)
# fit the dry-season Z-score baseline per AOI
fm.generate_mean_std_by_aoi()
# compute/cache the terrain-slope mask
fm.prepare_slope(dem_overview=0, buffer=500)
# search, read, reproject wet-season scenes
fm.prepare_wet_scenes(overview_level=None, max_workers=6)
# classify each scene against the baseline
fm.map_floods(vv_thd=-2.5, vh_thd=-2.5, rel_slope_thd=20,
export_raster=False, export_vector=False, export_maps=False)
# collapse per-scene results into one band per date
fm.merge_floods_by_date(export_raster=True)
# per-pixel count of scenes with data gaps
fm.generate_number_of_scenes(export_raster=True)
# aggregate per-date results into per-month flood-day counts
fm.monthly_sum()
See the documentation for full usage, API reference, and citation details: https://autofloods.readthedocs.io/en/latest/
1 maintainer
Metadata
1 maintainer
Release files for autofloods 0.1.0a16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| autofloods-0.1.0a16.tar.gz | 96.3 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| autofloods-0.1.0a16-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 171.3 kB
Release files / autofloods-0.1.0a16.tar.gz
| Download URL | autofloods-0.1.0a16.tar.gz |
|---|---|
| Size | 96.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7de92c9663d7242a72037c3f695b448197b12de69a1d40013c5ec33d550c68c8
|
|
BLAKE2b-256 checksum How to use checksums |
3caf05afc1bb6225c01a51db92cbcc6eca0b0b13f4f1d202b44bdc7122f45722
|
| 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 Sep 5, 2026.
Transparency logRelease files / autofloods-0.1.0a16-py3-none-any.whl
| Download URL | autofloods-0.1.0a16-py3-none-any.whl |
|---|---|
| Size | 75.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
823d737e4509255cc1850a2a62ff08c237327036a34fe2709f1cdea0e22eccc0
|
|
BLAKE2b-256 checksum How to use checksums |
27a455a5796884f46a302e225823342247b3ca1887ee78ea7176e2997461fa40
|
| 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 Sep 5, 2026.
Transparency logSecurity for autofloods 0.1.0a16
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for autofloods-0.1.0a16.tar.gz
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 Sep 5, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
