Skip to content

Commit 174b134

Browse files
committed
Document global-projection templates (#3549)
1 parent 171da52 commit 174b134

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ Built-in Numba JIT and CUDA projection kernels bypass pyproj for per-pixel coord
274274

275275
| Name | Description | Source | NumPy xr.DataArray | Dask xr.DataArray | CuPy GPU xr.DataArray | Dask GPU xr.DataArray |
276276
|:----------:|:------------|:------:|:----------------------:|:--------------------:|:-------------------:|:------:|
277-
| [from_template](xrspatial/templates.py) | Empty study-area grid for a named region (CONUS, NYC, ...), a world city (London, Tokyo, ... in its UTM zone) or country code; `preserve='area'/'shape'` picks an EPSG projection by property; `list_templates()` lists every accepted name | Custom || 🔼 | 🔼 | 🔼 |
277+
| [from_template](xrspatial/templates.py) | Empty study-area grid for a named region (CONUS, NYC, ...), a world city (London, Tokyo, ... in its UTM zone), a country code, or a whole-world projection (web_mercator, wgs84/latlon, equal_earth); `preserve='area'/'shape'` picks an EPSG projection by property; `list_templates()` lists every accepted name | Custom || 🔼 | 🔼 | 🔼 |
278278

279279
-----------
280280

docs/source/reference/templates.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ a region name, a world-city name, or a country code into a NaN-filled
99
:class:`xarray.DataArray` that follows the xarray-spatial array contract, so it
1010
feeds straight into the rest of the library. Cities (national capitals, major
1111
regional metros, and recognizable US secondary cities) come back as a metro
12-
bounding box in their UTM zone.
12+
bounding box in their UTM zone. Whole-world canvases are available in a few
13+
projections too: ``'web_mercator'`` (EPSG:3857), ``'wgs84'`` / ``'latlon'``
14+
(EPSG:4326), and ``'equal_earth'`` (EPSG:8857).
1315

1416
Call :func:`~xrspatial.templates.list_templates` to discover every name
1517
``from_template`` accepts (curated regions, world cities, and country codes).

0 commit comments

Comments
 (0)