Skip to main content

Spherical mercator and XYZ tile utilities

Project description

Build Status Coverage Status Documentation Status

Spherical mercator coordinate and tile utilities

Documentation: http://mercantile.readthedocs.io/en/latest/

The mercantile module provides ul(xtile, ytile, zoom) and bounds(xtile, ytile, zoom) functions that respectively return the upper left corner and bounding longitudes and latitudes for XYZ tiles, a xy(lng, lat) function that returns spherical mercator x and y coordinates, a tile(lng, lat, zoom) function that returns the tile containing a given point, and quadkey conversion functions quadkey(xtile, ytile, zoom) and quadkey_to_tile(quadkey) for translating between quadkey and tile coordinates.

>>> import mercantile
>>> mercantile.ul(486, 332, 10)
LngLat(lng=-9.140625, lat=53.33087298301705)
>>> mercantile.bounds(486, 332, 10)
LngLatBbox(west=-9.140625, south=53.12040528310657, east=-8.7890625, north=53.33087298301705)
>>> mercantile.xy(*mercantile.ul(486, 332, 10))
(-1017529.7205322663, 7044436.526761846)
>> mercantile.xy_bounds(486, 332, 10)
Bbox(left=-1017529.7205322663, bottom=7005300.768279833, right=-978393.962050256, top=7044436.526761846)
>>> mercantile.tile(*mercantile.ul(486, 332, 10) + (10,))
Tile(x=486, y=332, z=10)
>>> mercantile.quadkey(486, 332, 10)
'0313102310'
>>> mercantile.quadkey_to_tile('0313102310')
Tile(x=486, y=332, z=10)

Also in mercantile are functions to traverse the tile stack.

>>> mercantile.parent(486, 332, 10)
Tile(x=243, y=166, z=9)
>>> mercantile.children(mercantile.parent(486, 332, 10))
[Tile(x=486, y=332, z=10), Tile(x=487, y=332, z=10), Tile(x=487, y=333, z=10), Tile(x=486, y=333, z=10)]

Named tuples are used to represent tiles, coordinates, and bounding boxes.

Mercantile CLI

Mercantile’s command line interface, named “mercantile”, has commands for getting the shapes of Web Mercator tiles as GeoJSON and getting the tiles that intersect with a GeoJSON bounding box.

$ mercantile --help
Usage: mercantile [OPTIONS] COMMAND [ARGS]...

  Command line interface for the Mercantile Python package.

Options:
  -v, --verbose  Increase verbosity.
  -q, --quiet    Decrease verbosity.
  --help         Show this message and exit.

Commands:
  bounding-tile  Print the bounding tile of a lng/lat point, bounding box, or
                 GeoJSON objects.
  children       Print the children of the tile.
  parent         print the parent tile.
  quadkey        Convert to/from quadkeys.
  shapes         Print the shapes of tiles as GeoJSON.
  tiles          Print tiles that overlap or contain a lng/lat point, bounding
                 box, or GeoJSON objects.

See docs/cli.rst for more about the mercantile program.

See Also

supermercado is another python lib with added tile logic functionality (union tile shapes, find edge tiles, and find tile intersections for complex geometries).

node-sphericalmercator provides many of the same features for Node.

tilebelt has some of the GeoJSON features as mercantile and a few more (tile parents, quadkey).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mercantile-1.0b1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distributions

mercantile-1.0b1-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

mercantile-1.0b1-py2-none-any.whl (12.2 kB view details)

Uploaded Python 2

File details

Details for the file mercantile-1.0b1.tar.gz.

File metadata

  • Download URL: mercantile-1.0b1.tar.gz
  • Upload date:
  • Size: 9.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mercantile-1.0b1.tar.gz
Algorithm Hash digest
SHA256 ad0b4d72b84913c98d0d32c0ca9e1ab1159dda8e1aa83855268a9dda045abdd9
MD5 eb164f5a9a0038a1f0d2aaac52b0e182
BLAKE2b-256 b8d82fa8e166a0340d6e15ff6040a1913c2187ae9f8e46004f2a8cf0512ffef0

See more details on using hashes here.

File details

Details for the file mercantile-1.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for mercantile-1.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 5dd16894fbd7964c72a2f18e2808ad55b20559c365fcf1133decf461861d75f1
MD5 42c802cf3a2465edc6f005a36707deba
BLAKE2b-256 a289531102877a937e65a94ba72baeb07de3d8a37f346b3d5a856383e727bd6f

See more details on using hashes here.

File details

Details for the file mercantile-1.0b1-py2-none-any.whl.

File metadata

File hashes

Hashes for mercantile-1.0b1-py2-none-any.whl
Algorithm Hash digest
SHA256 65f3af8c27df1437ae43624392571a7fb996c9ad2d386e2f5e78a17c5f186c74
MD5 b16b722adbf0ff95f171a975b2d72520
BLAKE2b-256 fd834959f6d27c3657d9277518de27a52d289fd08727059f066ed0643e8ed544

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page