Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ Transformez is part of the [Continuous DEMs Project](https://continuous-dems.rea
- **Dynamic Hub-and-Spoke routing** — Automatically selects the optimal geodetic pathway (NAD83 or WGS84) for your transformation
- **Continuous coastal blending** — Seamlessly merges NOAA VDatum with global satellite altimetry (FES2014/DTU25)
- **Inland tidal decay** — Smart extrapolation with Hermite S-curve smoothing for flood modeling
- **Autonomous self-healing** — Automatic geoid fallbacks, corruption recovery, and HTDP tectonic fallbacks
- **Global coverage** — Works anywhere on Earth via dynamic proxy chaining when regional models are unavailable
- **Memory-safe** — Windowed I/O for transforming massive DEMs without loading them into RAM
- **CLI + Python API** — Use as a command-line tool or embed in your pipeline
- **Offline field use** — Pre-download grids with `transformez prefetch` for air-gapped environments

Expand All @@ -23,7 +21,7 @@ Transformez is part of the [Continuous DEMs Project](https://continuous-dems.rea
*(Above: A generated vertical shift grid transforming MLLW to NAVD88)*

```bash
transformez build -R loc:"new orleans" -E 3s -I mllw -O 5703
transformez build -R loc:"new orleans" -E 3s -I vdatum:mllw -O epsg:5703
```

## Installation:
Expand Down Expand Up @@ -59,7 +57,7 @@ import transformez

# Generate a Shift Grid
# Returns a 2D numpy array. Optionally saves to a file.
# Requesting "mllw" in India triggers the Global Fallback (FES2014) automatically.
# Requesting "mllw" in India triggers the Global Fallback automatically.
shift_array = transformez.generate_grid(
region=[80, 85, 10, 15], # [West, East, South, North]
increment="3s", # Grid resolution
Expand Down Expand Up @@ -94,15 +92,14 @@ utm_shift.write("mllw_to_navd88_utm.tif")
out_file = transformez.transform_raster(
input_raster="my_dem_mllw.tif",
datum_in="vdatum:mllw",
datum_out="5703+geoid:g2012b", # NAVD88 using specific GEOID12B
decay_pixels=0, # Set to 0 for infinite inland extrapolation (Modeling)
datum_out="epsg:5703",
output_raster="my_dem_navd88.tif"
)
```

## Learn More

Interested in how `transformez` routes complex multi-step transformations? Read the [Geodetic Methodology & Architecture](user_guide/methodology.md) guide to learn about the dynamic hub-and-spoke model, sign conventions, coastal blending, and autonomous self-healing.
Read the [User Guide](user_guide/index.md) to install Transformez, generate your first shift grid, and understand how it works — from reference inputs and the CLI/Python API through the [geodetic methodology](user_guide/methodology.md) behind the dynamic hub-and-spoke routing, sign conventions, and coastal blending.

```{toctree}
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user_guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This guide covers everything you need to install, use, and understand Transformez — from your first shift grid to the geodetic reasoning behind it.

Transformez transforms raster elevations between vertical datums — tidal datums, geoids, and ellipsoids — anywhere on Earth. Instead of a fixed lookup table, it resolves your input and output [references](references.md), plans the optimal geodetic pathway, and produces a **spatially varying shift grid** that you can generate from the [CLI](usage.md#command-line-interface), build through the Python API, or apply directly to a raster. Where regional models like NOAA VDatum end, Transformez continues the transformation across open ocean and inland using global proxies, coastal blending, and meter-based inland decay.
Transformez transforms raster elevations between vertical datums — tidal datums, geoids, and ellipsoids — anywhere on Earth. Instead of a fixed lookup table, it resolves your input and output [references](references.md), plans the optimal geodetic pathway, and produces a **spatially varying shift grid** that you can generate from the [CLI](usage.md#command-line-interface), build through the Python API, or apply directly to a raster.

## How to read this guide

Expand Down
Loading