Skip to main content

Web mercator 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.0.0.tar.gz (9.2 kB view details)

Uploaded Source

Built Distributions

mercantile-1.0.0-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

mercantile-1.0.0-py2-none-any.whl (12.3 kB view details)

Uploaded Python 2

File details

Details for the file mercantile-1.0.0.tar.gz.

File metadata

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

File hashes

Hashes for mercantile-1.0.0.tar.gz
Algorithm Hash digest
SHA256 de95b1d094f28d522867459afa54ebc141d20dd46e6fa7a81aee379f860643fa
MD5 07db5d9b5456c0ab0427726d8436aa9c
BLAKE2b-256 58e415da32f759ed0d54d4447af3357c729cdc777a705df7fce417a403ca1b63

See more details on using hashes here.

File details

Details for the file mercantile-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mercantile-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c85834194e2a541f4cf45e33b029d520748db0a7e137ced81ff111c5feb88af
MD5 8ccbab73243d6ee3dd0db6dc6fcd080a
BLAKE2b-256 283b5fd34a31d569d52012975d94c8ca43ae9bb86ca638c1308b620eb2f904ad

See more details on using hashes here.

File details

Details for the file mercantile-1.0.0-py2-none-any.whl.

File metadata

File hashes

Hashes for mercantile-1.0.0-py2-none-any.whl
Algorithm Hash digest
SHA256 dc0233fec2ecd96adfb30b159c8faa792630d469bc8ee384aca4991c354165cc
MD5 b75857c8d39c591917986eba602d8aa4
BLAKE2b-256 bffb2d0f00f3795d2bf21de385524965cce691aa3261edc544a52fd853a39610

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