Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentsarago committed Jul 21, 2023
1 parent 95b7830 commit ce6359e
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 27 deletions.
1 change: 0 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,4 @@ repos:
language_version: python
additional_dependencies:
- types-attrs
- types-cachetools
- pydantic~=2.0
12 changes: 12 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@

* update pydantic requirement to `~=2.0`

* add support for TileMatrixSets with Variable Matrix Width

* add `variableMatrixWidths` to the `TileMatrix` model

* add `TileMatrixSet._lr()` (and `lr()`) to retrieve the lower right coordinates of a tile (instead of using upper-left of tile+1)

* switch to `functools.cached_property` to cache properties (instead of cachetools.LRUcache)

* rename `_is_quadtree` property to `is_quadtree` in `TileMatrixSet` model

* fix possible bug in `TileMatrixSet._tile()` (and `.tile()`) method to make sure x or y are not greater than `matrixWidth - 1` or `matrixHeight - 1`

## 4.3.0 (2023-07-11)

* add `.srs` property to `CRSType`
Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,9 @@ Morecantile is like [mercantile](https://github.com/mapbox/mercantile) (the best

| Morecantile Version | OGC Specification Version | Link
| ------------------- | ------------------------- |---------
| 4.0 | 2.0 | https://docs.ogc.org/is/17-083r4/17-083r4.html
| 3.0 and earlier | 1.0 | http://docs.opengeospatial.org/is/17-083r2/17-083r2.html
| >=4.0 | 2.0 | https://docs.ogc.org/is/17-083r4/17-083r4.html
| =<3.0 | 1.0 | http://docs.opengeospatial.org/is/17-083r2/17-083r2.html

**Note**: Variable matrix width tile set are not supported.

## Install

Expand Down Expand Up @@ -92,10 +91,12 @@ More info can be found at https://developmentseed.org/morecantile/usage/

### Defaults Grids

`morecantile` provides a set of default TMS grids:
`morecantile` provides a set of default TileMatrixSets:

- **CDB1GlobalGrid** \*: CDB 1 Global Grid - EPGS:4326 (WGS84)
- **CanadianNAD83_LCC**: Lambert conformal conic NAD83 for Canada - EPSG:3978
- **EuropeanETRS89_LAEAQuad**: ETRS89-extended / LAEA Europe - EPGS:3035
- **GNOSISGlobalGrid** \*: GNOSIS Global Grid - EPGS:4326 (WGS84)
- **LINZAntarticaMapTilegrid**: LINZ Antarctic Map Tile Grid (Ross Sea Region) - EPSG:5482
- **NZTM2000Quad**: LINZ NZTM2000 Map Tile Grid - EPSG:2193
- **UPSAntarcticWGS84Quad**: Universal Polar Stereographic WGS 84 Quad for Antarctic - EPSG:5042
Expand All @@ -106,6 +107,8 @@ More info can be found at https://developmentseed.org/morecantile/usage/
- **WorldCRS84Quad**: CRS84 for the World
- **WorldMercatorWGS84Quad**: Elliptical Mercator projection - EPGS:3395

\* TileMatrixSets with variable Matrix Width (see https://docs.ogc.org/is/17-083r4/17-083r4.html#toc15)

ref: https://schemas.opengis.net/tms/2.0/json/examples/tilematrixset/

## Implementations
Expand Down
48 changes: 27 additions & 21 deletions docs/src/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,19 @@ Usage: morecantile tiles [OPTIONS] [ZOOM] [INPUT]
Options:
--identifier TileMatrixSet identifier.
One of :
- LINZAntarticaMapTilegrid
- EuropeanETRS89_LAEAQuad
- CDB1GlobalGrid
- CanadianNAD83_LCC
- UPSArcticWGS84Quad
- EuropeanETRS89_LAEAQuad
- GNOSISGlobalGrid
- LINZAntarticaMapTilegrid
- NZTM2000Quad
- UTM31WGS84Quad
- UPSAntarcticWGS84Quad
- WorldMercatorWGS84Quad
- WorldCRS84Quad
- WGS1984Quad
- UPSArcticWGS84Quad
- UTM31WGS84Quad
- WebMercatorQuad
- WGS1984Quad
- WorldCRS84Quad
- WorldMercatorWGS84Quad
--seq / --lf Write a RS-delimited JSON sequence (default is LF).
--help Show this message and exit.
```
Expand Down Expand Up @@ -87,17 +89,19 @@ Usage: morecantile shapes [OPTIONS] [INPUT]
Options:
--identifier TileMatrixSet identifier.
One of :
- LINZAntarticaMapTilegrid
- EuropeanETRS89_LAEAQuad
- CDB1GlobalGrid
- CanadianNAD83_LCC
- UPSArcticWGS84Quad
- EuropeanETRS89_LAEAQuad
- GNOSISGlobalGrid
- LINZAntarticaMapTilegrid
- NZTM2000Quad
- UTM31WGS84Quad
- UPSAntarcticWGS84Quad
- WorldMercatorWGS84Quad
- WorldCRS84Quad
- WGS1984Quad
- UPSArcticWGS84Quad
- UTM31WGS84Quad
- WebMercatorQuad
- WGS1984Quad
- WorldCRS84Quad
- WorldMercatorWGS84Quad
--precision INTEGER Decimal precision of coordinates.
--indent INTEGER Indentation level for JSON output
--compact / --no-compact Use compact separators (',', ':').
Expand Down Expand Up @@ -147,17 +151,19 @@ Usage: morecantile tms [OPTIONS]
Options:
--identifier TileMatrixSet identifier.
One of :
- LINZAntarticaMapTilegrid
- EuropeanETRS89_LAEAQuad
- CDB1GlobalGrid
- CanadianNAD83_LCC
- UPSArcticWGS84Quad
- EuropeanETRS89_LAEAQuad
- GNOSISGlobalGrid
- LINZAntarticaMapTilegrid
- NZTM2000Quad
- UTM31WGS84Quad
- UPSAntarcticWGS84Quad
- WorldMercatorWGS84Quad
- WorldCRS84Quad
- WGS1984Quad
- UPSArcticWGS84Quad
- UTM31WGS84Quad
- WebMercatorQuad
- WGS1984Quad
- WorldCRS84Quad
- WorldMercatorWGS84Quad
--help Show this message and exit.
```

Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ dependencies = [
"attrs",
"pyproj~=3.1",
"pydantic~=2.0",
"cachetools",
]

[project.optional-dependencies]
Expand Down

0 comments on commit ce6359e

Please sign in to comment.