Skip to main content

Rasterio reads and writes geospatial raster datasets.

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

Rasterio employs GDAL under the hood for file I/O and raster formatting. Its functions typically accept and return Numpy ndarrays. Rasterio is designed to make working with geospatial raster data more productive and more fun.

Rasterio is pronounced raw-STEER-ee-oh.

Example

Here’s a simple example of the basic features rasterio provides. Three bands are read from an image and summed to produce something like a panchromatic band. This new band is then written to a new single band TIFF.

import numpy
import rasterio
import subprocess

# Register GDAL format drivers and configuration options with a
# context manager.

with rasterio.drivers(CPL_DEBUG=True):

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

    # Combine arrays in place. Expecting that the sum will
    # temporarily exceed the 8-bit integer range, initialize it as
    # 16-bit. Adding other arrays to it in-place converts those
    # arrays "up" and preserves the type of the total array.

    total = numpy.zeros(r.shape, dtype=rasterio.uint16)
    for band in r, g, b:
        total += band
    total /= 3

    # Write the product as a raster band to a new 8-bit file. For
    # keyword arguments, 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.

    kwargs = src.meta
    kwargs.update(
        dtype=rasterio.uint8,
        count=1,
        compress='lzw')

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

# At the end of the ``with rasterio.drivers()`` block, context
# manager exits and all drivers are de-registered.

# Dump out gdalinfo's report card and open the image.

info = subprocess.check_output(
    ['gdalinfo', '-stats', 'example-total.tif'])
print(info)
subprocess.call(['open', 'example-total.tif'])
http://farm6.staticflickr.com/5501/11393054644_74f54484d9_z_d.jpg

The rasterio.drivers() function and context manager are new in 0.5. The example above shows the way to use it to register and de-register drivers in a deterministic and efficient way. Code written for rasterio 0.4 will continue to work: opened raster datasets may manage the global driver registry if no other manager is present.

API Overview

Simple access is provided to properties of a geospatial raster file.

with rasterio.drivers():

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

# Output:
# (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]

Rasterio also affords conversion of GeoTIFFs to other formats.

with rasterio.drivers():

    rasterio.copy(
        'example-total.tif',
        'example-total.jpg',
        driver='JPEG')

subprocess.call(['open', 'example-total.jpg'])

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_band(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)

>>> b.min(), b.max(), b.mean()
(1, 255, 44.434478650699106)

Installation

Dependencies

Rasterio has one C library dependency: GDAL >=1.9. GDAL itself depends on a number of other libraries provided by most major operating systems and also depends on the non standard GEOS and PROJ4 libraries.

Python package dependencies (see also requirements.txt): affine, cligj (and click), enum34, numpy.

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

Rasterio binaries for OS X

Binary wheels with the GDAL, GEOS, and PROJ4 libraries included are available for OS X versions 10.7+ starting with Rasterio version 0.17. To install, just 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-use-wheel 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).

Binary wheels for other operating systems will be available in a future release.

Installing from the source distribution

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 python-numpy libgdal1h gdal-bin libgdal-dev
$ pip install rasterio

Adapt them as necessary for your Linux system.

OS X

For a Homebrew based Python environment, do the following.

$ brew install gdal
$ pip install rasterio

Windows

Windows binary packages created by Christoph Gohlke are available here.

Testing

>From the repo directory, run py.test

$ py.test

Documentation

See https://github.com/mapbox/rasterio/tree/master/docs.

License

See LICENSE.txt

Authors

See AUTHORS.txt

Changes

See CHANGES.txt

Metadata

Release files for rasterio 0.17

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rasterio 0.17
File Size Uploaded
rasterio-0.17.tar.gz 793.8 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for rasterio 0.17
File Interpreter ABI Platform
rasterio-0.17-cp34-cp34m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl CPython 3.4 CPython 3.4 pymalloc macOS 10.9+ x86-64, macOS 10.6+ Intel (x86-64, i386), macOS 10.9+ Intel (x86-64, i386), macOS 10.10+ x86-64, macOS 10.10+ Intel (x86-64, i386) Details
rasterio-0.17-cp27-none-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl CPython 2.7 none macOS 10.6+ Intel (x86-64, i386), macOS 10.10+ Intel (x86-64, i386), macOS 10.9+ Intel (x86-64, i386), macOS 10.9+ x86-64, macOS 10.10+ x86-64 Details

Total release size: 29.9 MB

Release files / rasterio-0.17.tar.gz

Download URL rasterio-0.17.tar.gz
Size 793.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0a64b81d10c17834c0e21b37f59abcf878c9864f086ee68e5b83c82aebb0c96b
BLAKE2b-256 checksum
How to use checksums
0bc0c45af0bd7bad7d04d2429e87ac1bb343282d0d7e4e8f177ffcb6d83fc7c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / rasterio-0.17-cp34-cp34m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl

Download URL rasterio-0.17-cp34-cp34m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Size 14.5 MB
Tags CPython 3.4 CPython 3.4 pymalloc macOS 10.10+ Intel (x86-64, i386) macOS 10.10+ x86-64 macOS 10.6+ Intel (x86-64, i386) macOS 10.9+ Intel (x86-64, i386) macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
21510a9ed0091fdacabe5e9035e832bb29f0d308e21669e51670bbcb52098bcb
BLAKE2b-256 checksum
How to use checksums
bd85961490ffa320c088ef0448841d92a26588727048598b8d76826570ddd755
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / rasterio-0.17-cp27-none-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl

Download URL rasterio-0.17-cp27-none-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Size 14.6 MB
Tags CPython 2.7 macOS 10.10+ Intel (x86-64, i386) macOS 10.10+ x86-64 macOS 10.6+ Intel (x86-64, i386) macOS 10.9+ Intel (x86-64, i386) macOS 10.9+ x86-64
SHA-256 checksum
How to use checksums
fbb9c805d4210d9eb6056f2bd1adb1cc3bbf208caed6237172cbbe7a7f00abc7
BLAKE2b-256 checksum
How to use checksums
53b67174ba8917b11bd7d1727ff5185bc7427e8f9f87f9ad086b26f17c8e693e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

1.5.2

37 release files

1.4.4

42 release files

1.4.2

21 release files

1.4.0

21 release files

1.3.9

21 release files

1.3.8

17 release files

1.3.7

17 release files

1.3.6

17 release files

1.3.5

17 release files

1.3.4

13 release files

1.3.3

13 release files

1.3.2

10 release files

1.3.1

10 release files

1.2.10

9 release files

1.2.9

9 release files

1.2.8

9 release files

1.2.7

9 release files

1.2.6

9 release files

1.2.5

9 release files

1.2.4

9 release files

1.2.3

9 release files

1.2.2

9 release files

1.2.1

9 release files

1.2.0

9 release files

1.1.8

19 release files

1.1.7

10 release files

1.1.6

10 release files

1.1.3

11 release files

1.1.2

11 release files

1.1.1

11 release files

1.1.0

9 release files

1.0.26

9 release files

1.0.9

11 release files

1.0.7

10 release files

1.0.6

10 release files

1.0.5

10 release files

1.0.4

10 release files

1.0.2

12 release files

1.0.1

12 release files

1.0.0

12 release files

0.36.0

4 release files

0.32.0

4 release files

0.31.0

3 release files

0.30.0

3 release files

0.29.0

3 release files

0.27.0

3 release files

0.26.0

3 release files

0.25.0

3 release files

0.24.0

3 release files

0.21.0

3 release files

0.19.1

3 release files

0.19.0

3 release files

0.18

3 release files

0.17.1

3 release files

This release

0.17 This release

3 release files

0.16

1 release file

0.15.1

1 release file

0.15

1 release file

0.14.1

1 release file

0.14

1 release file

0.13.2

1 release file

0.13.1

1 release file

0.13

2 release files

0.12

3 release files

0.11.1

3 release files

0.11

3 release files

0.10.1

3 release files

0.10

3 release files

0.9

1 release file

0.8

1 release file

0.7.3

1 release file

0.7.2

1 release file

0.7.1

1 release file

0.7

1 release file

0.6

1 release file

0.5.1

1 release file

0.5

1 release file

0.4

1 release file

0.3

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page