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.org/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 supports Python 2.7 and 3.3-3.6 on Linux and Mac OS X.

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

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 >=1.11. 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 distributions may be available in the future.

OS X

Binary distributions with GDAL, GEOS, and PROJ4 libraries included are available for OS X versions 10.7+ starting with Rasterio version 0.17. 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:

$ pip install -U pip
$ pip install GDAL-2.0.2-cp27-none-win32.whl
$ pip install rasterio-0.34.0-cp27-cp27m-win32.whl

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-use-wheel rasterio

Alternatively, you can install GDAL binaries from kyngchaos. You will then need to add the installed location /Library/Frameworks/GDAL.framework/Programs to your system path.

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.

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

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 (gdal111.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

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.0.1.tar.gz (1.8 MB view details)

Uploaded Source

Built Distributions

rasterio-1.0.1-cp37-cp37m-manylinux1_x86_64.whl (18.6 MB view details)

Uploaded CPython 3.7m

rasterio-1.0.1-cp37-cp37m-macosx_10_9_x86_64.whl (23.0 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

rasterio-1.0.1-cp36-cp36m-manylinux1_x86_64.whl (18.6 MB view details)

Uploaded CPython 3.6m

rasterio-1.0.1-cp36-cp36m-macosx_10_9_x86_64.whl (23.0 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

rasterio-1.0.1-cp35-cp35m-manylinux1_x86_64.whl (18.5 MB view details)

Uploaded CPython 3.5m

rasterio-1.0.1-cp35-cp35m-macosx_10_9_intel.macosx_10_9_x86_64.whl (23.0 MB view details)

Uploaded CPython 3.5m macOS 10.9+ intel macOS 10.9+ x86-64

rasterio-1.0.1-cp34-cp34m-manylinux1_x86_64.whl (18.6 MB view details)

Uploaded CPython 3.4m

rasterio-1.0.1-cp34-cp34m-macosx_10_9_intel.macosx_10_9_x86_64.whl (23.0 MB view details)

Uploaded CPython 3.4m macOS 10.9+ intel macOS 10.9+ x86-64

rasterio-1.0.1-cp27-cp27mu-manylinux1_x86_64.whl (18.2 MB view details)

Uploaded CPython 2.7mu

rasterio-1.0.1-cp27-cp27m-manylinux1_x86_64.whl (18.2 MB view details)

Uploaded CPython 2.7m

rasterio-1.0.1-cp27-cp27m-macosx_10_9_x86_64.whl (23.1 MB view details)

Uploaded CPython 2.7m macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: rasterio-1.0.1.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for rasterio-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b96be3e541f9f7b672eaa7b41bbe68216b5dea3dc7bcd96ef00db3c2a9553b15
MD5 4716a53db701622bfb68a2d203bab2d3
BLAKE2b-256 efe2eea3c9fd760b2fd3c68152e287e18698a11997ca265bbcbde999c13f1521

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0.1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 572dee94ecf9409a2a80d2fe8da07d3f2fdd89884451a5866b4391539f89c0e9
MD5 193c8d15e0f497f64a5573979aed1ddd
BLAKE2b-256 eaa8854c1d1a327f2e6b8ac84f936e036bf75e07b6483d97548dda6c825326e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0.1-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 40ad484297edc480ff7eedc0a52ab866658f8fee151a851199b383b8abc04970
MD5 8773b52183ce90a1693005c266a5239e
BLAKE2b-256 c02336a32017118f0d36c3b7785992b399f7e926fec9f7f213772a7b5ea28835

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0.1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 2c0184bb15526b3b3b63a8c72dd3116cbb8f107f0a9fd686bbe880125f6a6a93
MD5 ef57198585830d14a65ca34b8a892840
BLAKE2b-256 fcf5d7cf81053d839d95a929089a12410c0a7034249ada203ebd89ff0a0bc955

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0.1-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 388e734e927b9acbc0b835d33613a11abaef0912c0fd0988cfe70ccb536de3f5
MD5 53f506aeea80ae9950b724d8a9249c59
BLAKE2b-256 772d4ae8e8d5904188e4f2b098de8ad7b4512c293d898596d22af52ecc3035ee

See more details on using hashes here.

File details

Details for the file rasterio-1.0.1-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.1-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0e22553d74b60897c571280e408dd49bb411f220c333706801cf529b409a0026
MD5 fd6fa26f09225760020441d79e0fdf83
BLAKE2b-256 bcdba909a8c74c043ed1078f79305b8954ba3ba1d8bebb7f5481599070bdec25

See more details on using hashes here.

File details

Details for the file rasterio-1.0.1-cp35-cp35m-macosx_10_9_intel.macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.1-cp35-cp35m-macosx_10_9_intel.macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 0b7d8227f659909aa71df341f24b9da5c824f0d1a7791e3b007f59dfeb01c0a1
MD5 d93e778544230e6f7bc8ffe2e49682de
BLAKE2b-256 8287ad1343977c91da7d654e6ee6def084e617faedbea43d9c7f07159e7f5524

See more details on using hashes here.

File details

Details for the file rasterio-1.0.1-cp34-cp34m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.1-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 1d226571bd6fdbf81ec615e29c6ba3bdffc3e0d8840b47f11d98d4e67b5f9342
MD5 855f1f9a84593bcbd4b78d490c6d38c8
BLAKE2b-256 06cb611b2b0324adb2bb6ec762ecf0b00f89bd2f7bbd9b4ee1d3cffa5310e277

See more details on using hashes here.

File details

Details for the file rasterio-1.0.1-cp34-cp34m-macosx_10_9_intel.macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.1-cp34-cp34m-macosx_10_9_intel.macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 2e7f0fe5cf0acb79861e30475de48a614a0089414546e2728303827a507aa891
MD5 cbe627775c6119839982bcf28687e9f0
BLAKE2b-256 f8418cc714995d64153b8c6d1db170517f49dad3afa0155b6dfc789b7e9f76ca

See more details on using hashes here.

File details

Details for the file rasterio-1.0.1-cp27-cp27mu-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.1-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 3937a65cc57df5cb34636b2942a2df70b7a8bade95da0adb8064c67139decb75
MD5 e026ea2ec24245a4ee21f934d5ef8b1b
BLAKE2b-256 20984bdfe4e57f2b764d61a191943c319db1b0729f6bed26c7bbf72df6402db2

See more details on using hashes here.

File details

Details for the file rasterio-1.0.1-cp27-cp27m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.1-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 96d7e87c3d48dfd8bc72e6ad841bff782c957b87f0c76109939106964abc114c
MD5 533872812b9fbc31a2387c0a0126672e
BLAKE2b-256 b98b6ec03685e200b6e07aa240eaeae9ce26e6d369ff9cc1f1853082ed8dfbc1

See more details on using hashes here.

File details

Details for the file rasterio-1.0.1-cp27-cp27m-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.1-cp27-cp27m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 553e954d11190a9fa6c782eae66d405612a59bc91506086cc32485a057429120
MD5 21570f086a24cce29a4752fa0411904f
BLAKE2b-256 b9e51d3d6c67d65657662c470e6ce813a72488373865797d5e08a8309d6ef599

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