AbovePy/examples/scripts/quickstart.py at main · chrislyonsKY/AbovePy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
"""abovepy Quickstart — Search, download, and mosaic DEM tiles.

This script demonstrates the core abovepy workflow:
1. Search for tiles by county name
2. Estimate download size
3. Download matching tiles
4. Mosaic into a single VRT

Usage:
    python quickstart.py
"""

from pathlib import Path

import abovepy


def main():
    output_dir = Path("./output/quickstart")
    output_dir.mkdir(parents=True, exist_ok=True)

    # Search for DEM Phase 3 tiles covering Franklin County (Frankfort)
    print("Searching for DEM tiles...")
    result = abovepy.search(county="Franklin", product="dem_phase3")
    print(result)  # SearchResult('dem_phase3', N tiles, ~X MB)

    # Estimate download size before committing
    est = result.estimate_size()
    print(f"Estimated download: {est['total_mb']} MB")

    # Download tiles (concurrent by default)
    print("\nDownloading tiles...")
    paths = result.download(output_dir=output_dir / "tiles")
    print(f"Downloaded {len(paths)} files")

    # Mosaic into a single VRT
    print("\nBuilding mosaic...")
    vrt = result.mosaic(output=output_dir / "franklin_dem.vrt")
    print(f"Mosaic created: {vrt}")


if __name__ == "__main__":
    main()

# Expected output:
# Searching for DEM tiles...
# SearchResult('dem_phase3', 342 tiles, ~1710.0 MB)
# Estimated download: 1710.0 MB
#
# Downloading tiles...
# Downloaded 342 files
#
# Building mosaic...
# Mosaic created: output/quickstart/franklin_dem.vrt