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

Uploaded Source

Built Distributions

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

Uploaded CPython 3.6m

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

Uploaded CPython 3.6m macOS 10.9+ x86-64

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

Uploaded CPython 3.5m

rasterio-1.0rc5-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.0rc5-cp34-cp34m-manylinux1_x86_64.whl (18.6 MB view details)

Uploaded CPython 3.4m

rasterio-1.0rc5-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.0rc5-cp27-cp27mu-manylinux1_x86_64.whl (18.2 MB view details)

Uploaded CPython 2.7mu

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

Uploaded CPython 2.7m

rasterio-1.0rc5-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.0rc5.tar.gz.

File metadata

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

File hashes

Hashes for rasterio-1.0rc5.tar.gz
Algorithm Hash digest
SHA256 282339a8e5f2a1236ef0c57635ea84d2176dfe9997460362aaa26a98a8229928
MD5 6ab544be9025b9c847061a4bafe0ecba
BLAKE2b-256 1cb1c347e0982aa632ba934094aa63a144c16b863fd68350f48a0c8fe9d11f74

See more details on using hashes here.

File details

Details for the file rasterio-1.0rc5-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 faea5764f735001219de86f558bb4c4fcb73c6e639e1bd503c8a8631c12aa414
MD5 bd1b3bd24a66491be29f9ea66bcf7e5e
BLAKE2b-256 7bcae384d004a40866f5883f91c2151c9743df31829abceeb543147072f8c454

See more details on using hashes here.

File details

Details for the file rasterio-1.0rc5-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 9ce3a760380df502cd2038f3b3bcac775e3149a85d96f46931ead169a9e80c0a
MD5 7e7cd81d1c944728dd453621f7d793d0
BLAKE2b-256 b42f30314cd3104b67528560d21d9196e534b8e5f6deb57e6b5c89bfd64064d7

See more details on using hashes here.

File details

Details for the file rasterio-1.0rc5-cp35-cp35m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 c3bfbc3561228996c063472256211d5970f5dbf40361f69e7a649dbe4c6ad44e
MD5 4557bbe62e13781ea3e3e51afcf6d113
BLAKE2b-256 dda03fc7cd628563f8cdc9a17290039cd84d3dd47853fe2827e2a9857d0e252b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp35-cp35m-macosx_10_9_intel.macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 320d1b02b37fe32d186f18cb85e86342a323474a54d1dedbe43ef0036c0674ea
MD5 be479210d5e6728ced0427f9f980040f
BLAKE2b-256 b7eb19bfce6a360a170f28c66725ff89ee918a23abd04e3d08a8df48603ce403

See more details on using hashes here.

File details

Details for the file rasterio-1.0rc5-cp34-cp34m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 56243631f46b55587830dd7be455eb721654470d5c8e4cd9be6bcd04dd053b51
MD5 1fd7d45109ab349154c49cdf20a6fcbe
BLAKE2b-256 220904a1ac77b4fb423f2893a558d7d062234c8060fbe6cf134090e11d6f32d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp34-cp34m-macosx_10_9_intel.macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 0b26cbe33280b03407241b0a2c5fb1db7753fe410933122abee550119436a849
MD5 6e319c92d7b6494a12890944897bfe5e
BLAKE2b-256 31436535d449624c27c3cc27042e396d787e802faed71abe6251badd9ff2e117

See more details on using hashes here.

File details

Details for the file rasterio-1.0rc5-cp27-cp27mu-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 135cbbdcda7affb29e20c8a608419212e9397e1984c704c9b087b32b4b9e6b7d
MD5 7174c9771e12b238dc29f3b19d6507a6
BLAKE2b-256 3140badeae0c68615a011bef577d3f0bf6e4421c1450230c53b4784e83cb9900

See more details on using hashes here.

File details

Details for the file rasterio-1.0rc5-cp27-cp27m-manylinux1_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 fc4c4134b2aa78a57071b5da2d6c94dfe7cac92dfe7e579861c6ae936b745280
MD5 748d105290d511ba93932be4d101ccbe
BLAKE2b-256 816d55e5df0793069a7d9698922b774fe0b06ae764e423bb948e58513553d202

See more details on using hashes here.

File details

Details for the file rasterio-1.0rc5-cp27-cp27m-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0rc5-cp27-cp27m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 6bc818552e6de78751af580d50e37be1590764bbd9681c426ef9e974b304ba65
MD5 0043692381a60086f5465c93ffb38335
BLAKE2b-256 812a09b23a06ccc6f07dacb716e1b649e061aaa27b7806fbd7d6eb3ceba022ab

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