Metadata-Version: 2.4
Name: ivert
Version: 0.6.0
Summary: The ICESat-2 Validation of Elevations Reporting Tool (IVERT)
Project-URL: Source, https://github.com/ciresdem/IVERT
Author-email: Michael MacFerrin <michael.macferrin@colorado.edu>
License: MIT License
        
        Copyright (c) 2023 CIRES Coastal DEM Group
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: Geospatial
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Requires-Dist: blosc2
Requires-Dist: click
Requires-Dist: dateparser
Requires-Dist: fetchez
Requires-Dist: gdal
Requires-Dist: geopandas
Requires-Dist: globato
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: netcdf4
Requires-Dist: numexpr
Requires-Dist: numpy
Requires-Dist: packaging
Requires-Dist: pandas
Requires-Dist: psutil
Requires-Dist: pyproj
Requires-Dist: rasterio
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: six
Requires-Dist: tabulate
Requires-Dist: transformez
Requires-Dist: xarray
Description-Content-Type: text/markdown

# IVERT
**ICESat-2 Validation of Elevations Reporting Tool**

IVERT validates Digital Elevation Models (DEMs) by comparing their elevations against ICESat-2 satellite photon data. It supports topographic, bathymetric, and mixed coastal DEMs, runs fully offline on any machine, and handles vertical datum conversions automatically.

Developed by the [CIRES Coastal DEM Team](https://ciresdem.github.io). Primary authors: [Mike MacFerrin](https://github.com/mmacferrin) (IVERT) and [Matthew Love](https://github.com/matth-love) ([continuous-dems](https://github.com/continuous-dems) utilities).

> **Note:** This repository will soon be ported over to the [continuous-dems](https://github.com/continuous-dems) ecosystem.

---

(TODO: Add some pretty pictures here)

---

## Capabilities

- Validate topographic, bathymetric, and coastal DEMs against ICESat-2 ATL03/ATL24 photons
- Combines [ATL03](https://nsidc.org/data/atl03/)/[ATL08](https://nsidc.org/data/atl08/)/[ATL13](https://nsidc.org/data/atl13/)/[ATL24](https://nsidc.org/data/atl24/) for photon-level classifications, plus external datasets (such as the [Global Buildings Atlas](https://tubvsig-so2sat-vm1.srv.mwn.de/)) to classify built structures.
- Additional coastline filtering to minimize false-positive ATL08 "ground" photons appearing offshore over water, and unreasonably-shallow "bathy floor" photons with large errors over deep water. 
- Automatic vertical datum conversions (NAVD88, EGM2008, MLLW, and many more)
- Configurable photon confidence and quality filtering
- Statistical outputs: bias, RMSE, NMAD, per-cell error maps
- Automatically-generated plots of DEM accuracies compared to ICESat-2.
- Export errors to GeoTIFF, GeoPackage, Shapefile, or XYZ text
- Local photon database management — download once, validate many times

---

## Installation

```bash
pip install ivert
```
(^ coming soon)

For development (editable install from this repo):

```bash
git clone https://github.com/ciresdem/IVERT.git
cd IVERT
pip install -e .
```

Three dependencies — `fetchez`, `globato`, and `transformez` — are pulled automatically from the [continuous-dems](https://github.com/continuous-dems) GitHub organization and do not need to be installed separately.

---

## Quick start

**1. Download ICESat-2 photon data for your area** (bounding box in W/E/S/N order):

```bash
ivert database download -- -74.0/-73.0/40.5/41.0
```

**2. Validate your DEM:**

```bash
ivert validate mydem.tif
```

**3. Check the output directory** for `mydem_results.h5`, a validation plot (`.png`), and error exports (`.tif`, `.gpkg`).

---

## Documentation

| Command | Description |
|---------|-------------|
| [ivert validate](docs/validate.md) | Validate DEMs against ICESat-2 data |
| [ivert database](docs/database.md) | Download and manage the local photon database |
| [ivert cache](docs/cache.md) | View and clear the local file cache |
| [ivert options](docs/options.md) | View and change configuration settings |
| [ivert upgrade](docs/upgrade.md) | Upgrade IVERT to the latest version |
