Skip to main content

Fast and direct raster I/O for use with Numpy and SciPy

Project description

Rasterio reads and writes geospatial raster data.

https://travis-ci.com/mapbox/rasterio.png?branch=master https://coveralls.io/repos/github/mapbox/rasterio/badge.svg?branch=master

Geographic information systems use GeoTIFF and other formats to organize and store gridded, or raster, datasets. Rasterio reads and writes these formats and provides a Python API based on N-D arrays.

Rasterio 1.2 works with Python versions 3.6 through 3.9, Numpy versions 1.15 and newer, and GDAL versions 2.3 through 3.2. Official binary packages for Linux and Mac OS X are available on PyPI. Unofficial binary packages for Windows are available through other channels.

Read the documentation for more details: https://rasterio.readthedocs.io/.

Example

Here’s an example of some basic features that Rasterio provides. Three bands are read from an image and averaged to produce something like a panchromatic band. This new band is then written to a new single band TIFF.

import numpy as np
import rasterio

# Read raster bands directly to Numpy arrays.
#
with rasterio.open('tests/data/RGB.byte.tif') as src:
    r, g, b = src.read()

# Combine arrays in place. Expecting that the sum will
# temporarily exceed the 8-bit integer range, initialize it as
# a 64-bit float (the numpy default) array. Adding other
# arrays to it in-place converts those arrays "up" and
# preserves the type of the total array.
total = np.zeros(r.shape)
for band in r, g, b:
    total += band
total /= 3

# Write the product as a raster band to a new 8-bit file. For
# the new file's profile, we start with the meta attributes of
# the source file, but then change the band count to 1, set the
# dtype to uint8, and specify LZW compression.
profile = src.profile
profile.update(dtype=rasterio.uint8, count=1, compress='lzw')

with rasterio.open('example-total.tif', 'w', **profile) as dst:
    dst.write(total.astype(rasterio.uint8), 1)

The output:

http://farm6.staticflickr.com/5501/11393054644_74f54484d9_z_d.jpg

API Overview

Rasterio gives access to properties of a geospatial raster file.

with rasterio.open('tests/data/RGB.byte.tif') as src:
    print(src.width, src.height)
    print(src.crs)
    print(src.transform)
    print(src.count)
    print(src.indexes)

# Printed:
# (791, 718)
# {u'units': u'm', u'no_defs': True, u'ellps': u'WGS84', u'proj': u'utm', u'zone': 18}
# Affine(300.0379266750948, 0.0, 101985.0,
#        0.0, -300.041782729805, 2826915.0)
# 3
# [1, 2, 3]

A rasterio dataset also provides methods for getting extended array slices given georeferenced coordinates.

with rasterio.open('tests/data/RGB.byte.tif') as src:
    print src.window(**src.window_bounds(((100, 200), (100, 200))))

# Printed:
# ((100, 200), (100, 200))

Rasterio CLI

Rasterio’s command line interface, named “rio”, is documented at cli.rst. Its rio insp command opens the hood of any raster dataset so you can poke around using Python.

$ rio insp tests/data/RGB.byte.tif
Rasterio 0.10 Interactive Inspector (Python 3.4.1)
Type "src.meta", "src.read(1)", or "help(src)" for more information.
>>> src.name
'tests/data/RGB.byte.tif'
>>> src.closed
False
>>> src.shape
(718, 791)
>>> src.crs
{'init': 'epsg:32618'}
>>> b, g, r = src.read()
>>> b
masked_array(data =
 [[-- -- -- ..., -- -- --]
 [-- -- -- ..., -- -- --]
 [-- -- -- ..., -- -- --]
 ...,
 [-- -- -- ..., -- -- --]
 [-- -- -- ..., -- -- --]
 [-- -- -- ..., -- -- --]],
             mask =
 [[ True  True  True ...,  True  True  True]
 [ True  True  True ...,  True  True  True]
 [ True  True  True ...,  True  True  True]
 ...,
 [ True  True  True ...,  True  True  True]
 [ True  True  True ...,  True  True  True]
 [ True  True  True ...,  True  True  True]],
       fill_value = 0)

>>> np.nanmin(b), np.nanmax(b), np.nanmean(b)
(0, 255, 29.94772668847656)

Rio Plugins

Rio provides the ability to create subcommands using plugins. See cli.rst for more information on building plugins.

See the plugin registry for a list of available plugins.

Installation

Please install Rasterio in a virtual environment so that its requirements don’t tamper with your system’s Python.

SSL certs

The Linux wheels on PyPI are built on CentOS and libcurl expects certs to be in /etc/pki/tls/certs/ca-bundle.crt. Ubuntu’s certs, for example, are in a different location. You may need to use the CURL_CA_BUNDLE environment variable to specify the location of SSL certs on your computer. On an Ubuntu system set the variable as shown below.

$ export CURL_CA_BUNDLE=/etc/ssl/certs/ca-certificates.crt

Dependencies

Rasterio has a C library dependency: GDAL >= 2.3. GDAL itself depends on some other libraries provided by most major operating systems and also depends on the non standard GEOS and PROJ4 libraries. How to meet these requirement will be explained below.

Rasterio’s Python dependencies are listed in its requirements.txt file.

Development also requires (see requirements-dev.txt) Cython and other packages.

Binary Distributions

Use a binary distributions that directly or indirectly provide GDAL if possible.

Linux

Rasterio distributions are available from UbuntuGIS and Anaconda’s conda-forge channel.

Manylinux1 wheels are available on PyPI.

OS X

Binary distributions with GDAL, GEOS, and PROJ4 libraries included are available for OS X versions 10.9+. To install, run pip install rasterio. These binary wheels are preferred by newer versions of pip.

If you don’t want these wheels and want to install from a source distribution, run pip install rasterio --no-binary rasterio instead.

The included GDAL library is fairly minimal, providing only the format drivers that ship with GDAL and are enabled by default. To get access to more formats, you must build from a source distribution (see below).

Windows

Binary wheels for rasterio and GDAL are created by Christoph Gohlke and are available from his website.

To install rasterio, simply download both binaries for your system (rasterio and GDAL) and run something like this from the downloads folder, adjusting for your Python version.

$ pip install -U pip
$ pip install GDAL-3.1.4-cp39-cp39‑win_amd64.whl
$ pip install rasterio‑1.1.8-cp39-cp39-win_amd64.whl

You can also install rasterio with conda using Anaconda’s conda-forge channel.

$ conda install -c conda-forge rasterio

Source Distributions

Rasterio is a Python C extension and to build you’ll need a working compiler (XCode on OS X etc). You’ll also need Numpy preinstalled; the Numpy headers are required to run the rasterio setup script. Numpy has to be installed (via the indicated requirements file) before rasterio can be installed. See rasterio’s Travis configuration for more guidance.

Linux

The following commands are adapted from Rasterio’s Travis-CI configuration.

$ sudo add-apt-repository ppa:ubuntugis/ppa
$ sudo apt-get update
$ sudo apt-get install gdal-bin libgdal-dev
$ pip install -U pip
$ pip install rasterio

Adapt them as necessary for your Linux system.

OS X

For a Homebrew based Python environment, do the following.

$ brew update
$ brew install gdal
$ pip install -U pip
$ pip install --no-binary rasterio

Windows

You can download a binary distribution of GDAL from here. You will also need to download the compiled libraries and headers (include files).

When building from source on Windows, it is important to know that setup.py cannot rely on gdal-config, which is only present on UNIX systems, to discover the locations of header files and libraries that rasterio needs to compile its C extensions. On Windows, these paths need to be provided by the user. You will need to find the include files and the library files for gdal and use setup.py as follows. You will also need to specify the installed gdal version through the GDAL_VERSION environment variable.

$ python setup.py build_ext -I<path to gdal include files> -lgdal_i -L<path to gdal library> install

With pip

$ pip install --no-use-pep517 --global-option -I<path to gdal include files> -lgdal_i -L<path to gdal library> .

Note: --no-use-pep517 is required as pip currently hasn’t implemented a way for optional arguments to be passed to the build backend when using PEP 517. See here for more details.

Alternatively environment variables (e.g. INCLUDE and LINK) used by MSVC compiler can be used to point to include directories and library files.

We have had success compiling code using the same version of Microsoft’s Visual Studio used to compile the targeted version of Python (more info on versions used here.).

Note: The GDAL DLL and gdal-data directory need to be in your Windows PATH otherwise rasterio will fail to work.

Support

The primary forum for questions about installation and usage of Rasterio is https://rasterio.groups.io/g/main. The authors and other users will answer questions when they have expertise to share and time to explain. Please take the time to craft a clear question and be patient about responses.

Please do not bring these questions to Rasterio’s issue tracker, which we want to reserve for bug reports and other actionable issues.

While Rasterio’s repo is in the Mapbox GitHub organization, Mapbox’s Support team is focused on customer support for its commercial platform and Rasterio support requests may be perfunctorily closed with or without a link to https://rasterio.groups.io/g/main. It’s better to bring questions directly to the main Rasterio group at groups.io.

Development and Testing

See CONTRIBUTING.rst.

Documentation

See docs/.

License

See LICENSE.txt.

Authors

See AUTHORS.txt.

Changes

See CHANGES.txt.

Who is Using Rasterio?

See here.

Project details


Release history Release notifications | RSS feed

This version

1.2.1

Download files

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

Source Distribution

rasterio-1.2.1.tar.gz (2.2 MB view details)

Uploaded Source

Built Distributions

rasterio-1.2.1-cp39-cp39-manylinux1_x86_64.whl (19.1 MB view details)

Uploaded CPython 3.9

rasterio-1.2.1-cp39-cp39-macosx_10_9_x86_64.whl (20.5 MB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

rasterio-1.2.1-cp38-cp38-manylinux1_x86_64.whl (19.1 MB view details)

Uploaded CPython 3.8

rasterio-1.2.1-cp38-cp38-macosx_10_9_x86_64.whl (20.5 MB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

rasterio-1.2.1-cp37-cp37m-manylinux1_x86_64.whl (19.1 MB view details)

Uploaded CPython 3.7m

rasterio-1.2.1-cp37-cp37m-macosx_10_9_x86_64.whl (20.5 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

rasterio-1.2.1-cp36-cp36m-manylinux1_x86_64.whl (19.1 MB view details)

Uploaded CPython 3.6m

rasterio-1.2.1-cp36-cp36m-macosx_10_9_x86_64.whl (20.6 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

Details for the file rasterio-1.2.1.tar.gz.

File metadata

  • Download URL: rasterio-1.2.1.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1.tar.gz
Algorithm Hash digest
SHA256 81d4181514c67dc660d7b8cf943ad55c4fb3e0a17ac893d92628ac928cfab3d8
MD5 7d585f25c68346b19ce8d6db0f317fc7
BLAKE2b-256 cf1579f2ed3d25b02ace4c3a07168ef4a3ff34afc86537d118fd25230df6830f

See more details on using hashes here.

File details

Details for the file rasterio-1.2.1-cp39-cp39-manylinux1_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2.1-cp39-cp39-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.1 MB
  • Tags: CPython 3.9
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1-cp39-cp39-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 f255a98673b1bf52eb439c25bf6340c833e606fb48cea36bb82e341f67d84db4
MD5 46c96b1dc6bb871dab71c61cfd5b4d28
BLAKE2b-256 5480bd8cf4e255058f4a7aebd5b3e1ab8cea350c974565061652358ca79f3a2c

See more details on using hashes here.

File details

Details for the file rasterio-1.2.1-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2.1-cp39-cp39-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 20.5 MB
  • Tags: CPython 3.9, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 538ebcf0d0978cef446efa9610f9651348b166b5cbc0d83d93b628e4e4daff32
MD5 c1903cff9832a2c216c04af049213c15
BLAKE2b-256 010e9a11e21e8a959f64082d00798f2584b0ff9adaa2c15e5fdae7ec735358fd

See more details on using hashes here.

File details

Details for the file rasterio-1.2.1-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2.1-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.1 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c72741e681863fc505812252a696b4983f22733aefc00cc6ae5f22ab241c7064
MD5 48f9b3e08eb42d017c189fdada23b360
BLAKE2b-256 40a0a2fe8415280f48209f58087a3a8718a25182421624a77c7f1658d227d090

See more details on using hashes here.

File details

Details for the file rasterio-1.2.1-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2.1-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 20.5 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 35dd649effb1acd7ae1fb263dfa95f21d83bb5e20b195012249a32f4f5661d38
MD5 c07ab886d973284183b5e4f3896962c2
BLAKE2b-256 a34e91e85ac686df3065c80b0177305bc9baf21849fd748f8797089ad5bea6a7

See more details on using hashes here.

File details

Details for the file rasterio-1.2.1-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2.1-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.1 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c6103e58494f97e309a1dc6034c4df26006a12414a82f96d35c5420b79e2c4c9
MD5 05406800b72d6aac9bc7e725f92bdb49
BLAKE2b-256 043740712857e6c82cac52051d9faee43bc468e5806640ddbf88e10d591dbdf1

See more details on using hashes here.

File details

Details for the file rasterio-1.2.1-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2.1-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 20.5 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 907686a165877c7133b283c2dee57fa52b4bbcdc622bb455b005cacd16dba411
MD5 fa62f6b4143e463712cdc408a211d116
BLAKE2b-256 7b3c7adf1c678723f7417b196bcf56d385eadc74b4beef6f4c6aa84c90002623

See more details on using hashes here.

File details

Details for the file rasterio-1.2.1-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2.1-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.1 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 441b0e95ee89d100ab8db950c2de7ba57632f8d8940cc9a5592f0f87d6e36f0c
MD5 c99b915e218001df1e3c0817601cc743
BLAKE2b-256 1238b85be9f08c25d0be01643da0c48e72281f9084f7b800e0f0f29c8b384a25

See more details on using hashes here.

File details

Details for the file rasterio-1.2.1-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2.1-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 20.6 MB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2.1-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 d9c9e7a968ef8b89700d3a14497ac61c6178e8342a2cbf717d725d85404d8e97
MD5 4c7914f969f1cad8d6539a79edf3255d
BLAKE2b-256 2bcb229d9a29d3e3401fc09c4fcac7e1031cf3ad91561288d455e3f35bbfd0ac

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