Skip to content

Commit b1ba6a4

Browse files
authored
Docs and Readmes (#169)
* Tidy user guide intro * Link to user guide from index * modernize usage syntax * wording * Update key features
1 parent 6450051 commit b1ba6a4

2 files changed

Lines changed: 5 additions & 8 deletions

File tree

docs/source/index.md

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

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

2523
```bash
26-
transformez build -R loc:"new orleans" -E 3s -I mllw -O 5703
24+
transformez build -R loc:"new orleans" -E 3s -I vdatum:mllw -O epsg:5703
2725
```
2826

2927
## Installation:
@@ -59,7 +57,7 @@ import transformez
5957

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

103100
## Learn More
104101

105-
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.
102+
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.
106103

107104
```{toctree}
108105
:maxdepth: 2

docs/source/user_guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

5-
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.
5+
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.
66

77
## How to read this guide
88

0 commit comments

Comments
 (0)