Metadata-Version: 2.4
Name: mrms-usgs-events
Version: 0.1.1
Summary: Pipeline for downloading USGS site data, extracting events, and generating MRMS RadarOnly Zarr datasets.
Author-email: Gonzalo Forero <gonzaloforero57@gmail.com>, Jacob Johnson <jjohnson@aquaveo.com>
License: MIT
Project-URL: Repository, https://github.com/GonzaloAlbertoForeroBuitrago/mrms_usgs_events
Keywords: usgs,mrms,hydrology,geoscience,zarr,data-pipeline
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: typer>=0.9
Requires-Dist: pandas
Requires-Dist: xarray
Requires-Dist: zarr
Requires-Dist: requests
Requires-Dist: pyarrow
Requires-Dist: Hydro-Event-Detector
Requires-Dist: geopandas

## Citation
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19378062.svg)](https://doi.org/10.5281/zenodo.19378062)
## For windows in a  WSL terminal. Environment creation and package Installation
conda create -n mrms_usgs_events -c conda-forge python=3.11 gdal geopandas libgdal-grib -y

conda activate mrms_usgs_events

python -m pip install --upgrade pip               # Upgrade pip

python -m pip install mrms-usgs-events            # Install the package

gdalinfo --formats | grep -i grib                 # Verify gdal grib

mrms-usgs --help                                  # Verify installation

## Example use for the Texas July 4 2025 event at the Mystic Camp. (Use at least 1 year between start and end) 

mrms-usgs run-site 08165500 \
  --start 2023-07-01 \
  --end 2025-07-10 \
  --base-dir data \
  --overwrite
## Data directory with subfolders created following this structure
data/

├── _mrms_cache/     # Temporary cache of downloaded MRMS .grib2 files to avoid re-downloading 

├── basins_json/     # Watershed boundaries (GeoJSON) for each USGS station (used to mask rainfall)

├── events/          # Detected hydrologic events (CSV files with peaks, volumes, and timing)

├── logs/            # Execution logs for debugging and tracking pipeline progress

├── rain_zarr/       # Processed rainfall data stored in Zarr format (spatial + temporal arrays)

├── site_meta/       # Metadata for each USGS station (location, name, timezone, etc.)

└── stage_parquet/   # Time series of water level (stage) data from USGS in Parquet format


## Acknowledgements

This material is based upon work supported by the U.S. National Science Foundation under Grant No. TI-2303756 and the Tethys Geoscience Foundation.
