Skip to main content

A Rasterio plugin command that exports MBTiles

Project description

https://travis-ci.org/mapbox/rio-mbtiles.svg

A plugin for the Rasterio CLI that exports a raster dataset to the MBTiles (version 1.3) format. Features include automatic reprojection and concurrent tile generation.

Usage

Usage: rio mbtiles [OPTIONS] INPUT [OUTPUT]

  Export a dataset to MBTiles (version 1.3) in a SQLite file.

  The input dataset may have any coordinate reference system. It must have
  at least three bands, which will be become the red, blue, and green bands
  of the output image tiles.

  An optional fourth alpha band may be copied to the output tiles by using
  the --rgba option in combination with the PNG or WEBP formats. This option
  requires that the input dataset has at least 4 bands.

  The default quality for JPEG and WEBP output (possible range: 10-100) is
  75. This value can be changed with the use of the QUALITY creation option,
  e.g. `--co QUALITY=90`.  The default zlib compression level for PNG output
  (possible range: 1-9) is 6. This value can be changed like `--co
  ZLEVEL=8`.  Lossless WEBP can be chosen with `--co LOSSLESS=TRUE`.

  If no zoom levels are specified, the defaults are the zoom levels nearest
  to the one at which one tile may contain the entire source dataset.

  If a title or description for the output file are not provided, they will
  be taken from the input dataset's filename.

  This command is suited for small to medium (~1 GB) sized sources.

  Python package: rio-mbtiles (https://github.com/mapbox/rio-mbtiles).

Options:
  -o, --output PATH               Path to output file (optional alternative to
                                  a positional arg).

  --append / --overwrite          Append tiles to an existing file or
                                  overwrite.

  --title TEXT                    MBTiles dataset title.
  --description TEXT              MBTiles dataset description.
  --overlay                       Export as an overlay (the default).
  --baselayer                     Export as a base layer.
  -f, --format [JPEG|PNG|WEBP]    Tile image format.
  --tile-size INTEGER             Width and height of individual square tiles
                                  to create.  [default: 256]

  --zoom-levels MIN..MAX          A min...max range of export zoom levels. The
                                  default zoom level is the one at which the
                                  dataset is contained within a single tile.

  --image-dump PATH               A directory into which image tiles will be
                                  optionally dumped.

  -j INTEGER                      Number of workers (default: number of
                                  computer's processors).

  --src-nodata FLOAT              Manually override source nodata
  --dst-nodata FLOAT              Manually override destination nodata
  --resampling [nearest|bilinear|cubic|cubic_spline|lanczos|average|mode|gauss|max|min|med|q1|q3|rms]
                                  Resampling method to use.  [default:
                                  nearest]

  --version                       Show the version and exit.
  --rgba                          Select RGBA output. For PNG or WEBP only.
  --implementation [cf|mp]        Concurrency implementation. Use
                                  concurrent.futures (cf) or multiprocessing
                                  (mp).

  -#, --progress-bar              Display progress bar.
  --covers TEXT                   Restrict mbtiles output to cover a quadkey
  --cutline PATH                  Path to a GeoJSON FeatureCollection to be
                                  used as a cutline. Only source pixels within
                                  the cutline features will be exported.

  --oo NAME=VALUE                 Format driver-specific options to be used
                                  when accessing the input dataset. See the
                                  GDAL format driver documentation for more
                                  information.

  --co, --profile NAME=VALUE      Driver specific creation options. See the
                                  documentation for the selected output driver
                                  for more information.

  --wo NAME=VALUE                 See the GDAL warp options documentation for
                                  more information.

  --exclude-empty-tiles / --include-empty-tiles
                                  Whether to exclude or include empty tiles
                                  from the output.

  --help                          Show this message and exit.

Performance

The rio-mbtiles command is suited for small to medium (~1 GB) raster sources. On a MacBook Air, the 1:10M scale Natural Earth raster (a 21,600 x 10,800 pixel, 700 MB TIFF) exports to MBTiles (levels 1 through 5) in 45 seconds.

$ time GDAL_CACHEMAX=256 rio mbtiles NE1_HR_LC.tif \
> -o ne.mbtiles --zoom-levels 1..5 -j 4

real    0m44.925s
user    1m20.152s
sys     0m22.428s

Installation

pip install rio-mbtiles

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

rio-mbtiles-1.6a2.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

rio_mbtiles-1.6a2-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file rio-mbtiles-1.6a2.tar.gz.

File metadata

  • Download URL: rio-mbtiles-1.6a2.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.7

File hashes

Hashes for rio-mbtiles-1.6a2.tar.gz
Algorithm Hash digest
SHA256 5064f6a01469538aae80d5cf9c63a001e9ed6501fb513fa5ad9a6c22714ebd5e
MD5 27479f2e649e0fccab705f417be6d19a
BLAKE2b-256 4b7b38159595a4511d011f30d54249702ba9b56deee45c4055af5b69caca7bda

See more details on using hashes here.

File details

Details for the file rio_mbtiles-1.6a2-py3-none-any.whl.

File metadata

  • Download URL: rio_mbtiles-1.6a2-py3-none-any.whl
  • Upload date:
  • Size: 14.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.6.7

File hashes

Hashes for rio_mbtiles-1.6a2-py3-none-any.whl
Algorithm Hash digest
SHA256 502282f1b5e145f8a5eb4d1b7403e98827b25fb88e4d9f03ccb01ae0841fb4e2
MD5 4edb3ae5f6b2129a8cfc59f1d84e2fe7
BLAKE2b-256 006631415c9f789537626eda27de651054c77ea26bf5bd1ada946a189194cf6b

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