floodsr 0.0.1__tar.gz

floodsr-0.0.1/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: floodsr
+Version: 0.0.1
+Summary: Flood super-resolution CLI and library using ONNX Runtime.
+Author: floodsr developers
+License: Proprietary
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.24
+Requires-Dist: onnxruntime>=1.18
+Requires-Dist: platformdirs>=4.0
+Requires-Dist: pystac-client>=0.9
+Requires-Dist: pydantic>=2.5
+Requires-Dist: rasterio>=1.3
+Requires-Dist: tqdm>=4.0
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+
+# floodsr
+[![Documentation Status](https://readthedocs.org/projects/floodsr/badge/?version=latest)](https://floodsr.readthedocs.io/en/latest/)
+
+Super-Resolution for flood hazard rasters.
+Ingests lores water grid and hires DEM and infers a hires water grid using the specified model.
+
+Documentation: https://floodsr.readthedocs.io/en/latest/
+
+Implemented models (see `floodsr/models.json`):
+- **ResUNet_16x_DEM**: 16x DEM-conditioned ResUNet
+- **CostGrow** (future)
+
+Implemented backend:
+- **ONNX Runtime**
+
+
+## Installation
+
+```bash
+# recommended: isolated CLI install for users
+python -m pip install --user pipx
+pipx ensurepath
+pipx install floodsr
+```
+
+TestPyPI install:
+
+```bash
+pipx install --index-url https://test.pypi.org/simple/ --pip-args="--extra-index-url https://pypi.org/simple" floodsr
+```
+
+Developer install:
+
+```bash
+pip install -e ".[dev]"
+```
+
+
+## Use
+
+Current CLI surface includes model registry, `tohr` raster execution, and runtime diagnostics.
+
+List available model versions:
+
+```bash
+# dev shortcut for the CLI
+alias floodsr='python -m floodsr.cli'
+
+floodsr models list
+```
+
+Fetch a model by version into the default cache:
+
+```bash
+floodsr models fetch ResUNet_16x_DEM --force
+```
+
+tohr using HRDEM as DEM
+```bash
+floodsr tohr -f --in tests/data/2407_FHIMP_tile/lowres032.tif 
+```
+
+Run one ToHR pass from raster inputs:
+
+```bash
+# simple tile
+floodsr tohr \
+  --in tests/data/2407_FHIMP_tile/lowres032.tif \
+  --dem tests/data/2407_FHIMP_tile/hires002_dem.tif  
+
+# larger raster w/ windowing and tiling and rescaling
+floodsr tohr \
+  --in tests/data/rss_mersch_A/lowres030.tif \
+  --dem tests/data/rss_mersch_A/hires002_dem.tif \
+  --out pred_sr.tif
+ 
+```
+
+Run ToHR with explicit local model path:
+
+```bash
+floodsr tohr \
+  --in tests/data/2407_FHIMP_tile/lowres032.tif \
+  --dem tests/data/2407_FHIMP_tile/hires002_dem.tif \
+  --out ./tmp/pred_sr.tif \
+  --model-path _inputs/ResUNet_16x_DEM/model_infer.onnx
+```
+
+
+
+Doctor diagnostics:
+
+```bash
+floodsr doctor
+```
+
+ 

floodsr-0.0.1/README.md

@@ -0,0 +1,97 @@
+# floodsr
+[![Documentation Status](https://readthedocs.org/projects/floodsr/badge/?version=latest)](https://floodsr.readthedocs.io/en/latest/)
+
+Super-Resolution for flood hazard rasters.
+Ingests lores water grid and hires DEM and infers a hires water grid using the specified model.
+
+Documentation: https://floodsr.readthedocs.io/en/latest/
+
+Implemented models (see `floodsr/models.json`):
+- **ResUNet_16x_DEM**: 16x DEM-conditioned ResUNet
+- **CostGrow** (future)
+
+Implemented backend:
+- **ONNX Runtime**
+
+
+## Installation
+
+```bash
+# recommended: isolated CLI install for users
+python -m pip install --user pipx
+pipx ensurepath
+pipx install floodsr
+```
+
+TestPyPI install:
+
+```bash
+pipx install --index-url https://test.pypi.org/simple/ --pip-args="--extra-index-url https://pypi.org/simple" floodsr
+```
+
+Developer install:
+
+```bash
+pip install -e ".[dev]"
+```
+
+
+## Use
+
+Current CLI surface includes model registry, `tohr` raster execution, and runtime diagnostics.
+
+List available model versions:
+
+```bash
+# dev shortcut for the CLI
+alias floodsr='python -m floodsr.cli'
+
+floodsr models list
+```
+
+Fetch a model by version into the default cache:
+
+```bash
+floodsr models fetch ResUNet_16x_DEM --force
+```
+
+tohr using HRDEM as DEM
+```bash
+floodsr tohr -f --in tests/data/2407_FHIMP_tile/lowres032.tif 
+```
+
+Run one ToHR pass from raster inputs:
+
+```bash
+# simple tile
+floodsr tohr \
+  --in tests/data/2407_FHIMP_tile/lowres032.tif \
+  --dem tests/data/2407_FHIMP_tile/hires002_dem.tif  
+
+# larger raster w/ windowing and tiling and rescaling
+floodsr tohr \
+  --in tests/data/rss_mersch_A/lowres030.tif \
+  --dem tests/data/rss_mersch_A/hires002_dem.tif \
+  --out pred_sr.tif
+ 
+```
+
+Run ToHR with explicit local model path:
+
+```bash
+floodsr tohr \
+  --in tests/data/2407_FHIMP_tile/lowres032.tif \
+  --dem tests/data/2407_FHIMP_tile/hires002_dem.tif \
+  --out ./tmp/pred_sr.tif \
+  --model-path _inputs/ResUNet_16x_DEM/model_infer.onnx
+```
+
+
+
+Doctor diagnostics:
+
+```bash
+floodsr doctor
+```
+
+ 

floodsr-0.0.1/floodsr/__init__.py

@@ -0,0 +1,9 @@
+"""floodsr package."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    # Read installed package metadata so version stays tied to pyproject.toml.
+    __version__ = version("floodsr")
+except PackageNotFoundError:
+    __version__ = "0+unknown"

floodsr-0.0.1/floodsr/cache_paths.py

@@ -0,0 +1,40 @@
+"""Cache path helpers for model weights."""
+
+import logging
+from pathlib import Path
+from platformdirs import user_cache_dir
+
+
+APP_NAME = "floodsr"
+APP_AUTHOR = "floodsr"
+log = logging.getLogger(__name__)
+
+
+def get_cache_dir(cache_dir: str | Path | None = None) -> Path:
+    """Return a writable cache directory and ensure it exists."""
+    # Prefer an explicit cache directory when one is supplied.
+    if cache_dir is not None:
+        path = Path(cache_dir).expanduser().resolve()
+    else:
+        # Use a stable platform cache path.
+        path = Path(user_cache_dir(APP_NAME, APP_AUTHOR))
+    path.mkdir(parents=True, exist_ok=True)
+    assert path.exists(), f"failed to create cache directory: {path}"
+    log.debug(f"resolved cache directory to\n    {path}")
+    return path
+
+
+def get_model_cache_path(
+    model_version: str,
+    file_name: str,
+    cache_dir: str | Path | None = None,
+) -> Path:
+    """Return the cache path for a specific model file."""
+    assert model_version, "model_version cannot be empty"
+    assert file_name, "file_name cannot be empty"
+
+    # Group each model version under its own cache subdirectory.
+    model_fp = get_cache_dir(cache_dir) / model_version / file_name
+    model_fp.parent.mkdir(parents=True, exist_ok=True)
+    log.debug(f"resolved model cache path to\n    {model_fp}")
+    return model_fp

floodsr-0.0.1/floodsr/checksums.py

@@ -0,0 +1,46 @@
+"""Checksum helpers for model artifacts."""
+
+import hashlib
+import logging
+from pathlib import Path
+
+
+log = logging.getLogger(__name__)
+
+
+def compute_sha256(file_path: str | Path, chunk_size: int = 1024 * 1024) -> str:
+    """Compute the SHA256 digest for a file."""
+    path = Path(file_path)
+    assert path.exists(), f"file does not exist: {path}"
+    assert path.is_file(), f"path is not a file: {path}"
+    log.debug(f"computing sha256 for\n    {path}")
+
+    # Stream file bytes to avoid loading large model files into memory.
+    hasher = hashlib.sha256()
+    with path.open("rb") as stream:
+        chunk = stream.read(chunk_size)
+        while chunk:
+            hasher.update(chunk)
+            chunk = stream.read(chunk_size)
+    return hasher.hexdigest()
+
+
+def verify_sha256(file_path: str | Path, expected_sha256: str) -> bool:
+    """Return True when a file digest matches the expected SHA256."""
+    assert expected_sha256, "expected_sha256 cannot be empty"
+    actual_sha256 = compute_sha256(file_path)
+    is_match = actual_sha256.lower() == expected_sha256.strip().lower()
+    log.debug(f"sha256 verification result for\n    {file_path}\n    match={is_match}")
+    return is_match
+
+
+def assert_sha256(file_path: str | Path, expected_sha256: str) -> None:
+    """Raise ValueError when the file digest mismatches the expected SHA256."""
+    assert expected_sha256, "expected_sha256 cannot be empty"
+    actual_sha256 = compute_sha256(file_path)
+    if actual_sha256.lower() != expected_sha256.strip().lower():
+        raise ValueError(
+            f"checksum mismatch for {file_path}: "
+            f"expected {expected_sha256}, got {actual_sha256}"
+        )
+    log.debug(f"sha256 assertion passed for\n    {file_path}")