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 1.0.x works with Python versions 2.7.x and 3.5.0 through 3.7.x, and GDAL versions 1.11.x through 2.4.x. Official binary packages for Linux and Mac OS X are available on PyPI. Unofficial binary packages for Windows are available through other channels.

Rasterio 1.0.x is not compatible with GDAL versions 3.0.0 or greater.

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 >=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 wheels are available on PyPI.

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

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

Uploaded Source

Built Distributions

rasterio-1.1.6-cp38-cp38-manylinux1_x86_64.whl (18.2 MB view details)

Uploaded CPython 3.8

rasterio-1.1.6-cp38-cp38-macosx_10_9_x86_64.whl (17.5 MB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

rasterio-1.1.6-cp37-cp37m-manylinux1_x86_64.whl (18.3 MB view details)

Uploaded CPython 3.7m

rasterio-1.1.6-cp37-cp37m-macosx_10_9_x86_64.whl (17.4 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

rasterio-1.1.6-cp36-cp36m-manylinux1_x86_64.whl (18.3 MB view details)

Uploaded CPython 3.6m

rasterio-1.1.6-cp36-cp36m-macosx_10_9_x86_64.whl (17.5 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

rasterio-1.1.6-cp35-cp35m-manylinux1_x86_64.whl (18.2 MB view details)

Uploaded CPython 3.5m

rasterio-1.1.6-cp35-cp35m-macosx_10_9_intel.whl (17.4 MB view details)

Uploaded CPython 3.5m macOS 10.9+ intel

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

Uploaded CPython 2.7mu

File details

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

File metadata

  • Download URL: rasterio-1.1.6.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6.tar.gz
Algorithm Hash digest
SHA256 c098881dfe301c5e3aa43a3171985fb365d64dc4d1c0a1d8288c7870fb240efe
MD5 0f95b8663bdb78cbf194abcb45e2fd5d
BLAKE2b-256 c0e0a055775339c04db97a92254b08d70a796ff0cc8b4c9a23f92daa1dc96612

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.1.6-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.2 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 078c6b7756fcd98c517479ac5db99fbc71f17470287ca1513d8c4124d6a01f17
MD5 c98c17964dfe86962a5efea3b551634b
BLAKE2b-256 b3af50a79e03361aaae8393e2c43373376e81c21b8a4e3f8f73474f95ac1e7c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.1.6-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 17.5 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 6a62064744fdae0eccc355347f756ce2beece8c509aefbfb32c27e3a6aeb97ca
MD5 08dcc9d01eeba4d935baae46d785ce0a
BLAKE2b-256 32049f38bc42a2fe08adaad77fccb59ecc49707617408186ad5402a12ba33d3d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.1.6-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.3 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 23603a8b2e492fb971d7707b886886aeda20daa40959e25a929ba6049f91506c
MD5 2fbed85f68f158cadfe5dc5de8116f05
BLAKE2b-256 1ed97c3a2546b590eeeb8ee357769069919683aba9042f4ff50a02ab5789608e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.1.6-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 17.4 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 b96ea842184a395eb90b6d7cef7532b4b6cc93e7ac7d9490ac80861991afa3ae
MD5 a3d91c6cefa8af2ef816185c2a2d9027
BLAKE2b-256 bb6cfcc2f1b8d2c5eedcf072e0ccc5e8d1bd6f1920a6befea8611867f38f3007

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.1.6-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.3 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 01dfb3f7a1a730c7417465903aadbf3651ffea10114c01e4e4d190a7739ef1c5
MD5 62c8a6919dc931ef77ab96e4f62b8dd2
BLAKE2b-256 342bc8de31dc2767ef1cdcec980b3fe041776262bcdc859417babaeaad42cf3f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.1.6-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 17.5 MB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 0536624352e3c7046ffb5f0a70afc4f0508b76b8d0e69a13793701da091fe5b1
MD5 b93cfc7c7751d78344d7f0f020097638
BLAKE2b-256 e31a919bd8d321d5bf9ec5ccd615a8e6a8f3121aea65b82852cabaeb474fb763

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.1.6-cp35-cp35m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.2 MB
  • Tags: CPython 3.5m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 b0d5651459ec8c1cd89767a796b9d75321a784c3a7fd8afaf36c6704384911f0
MD5 acc7de46ce04e5af1313d95aca70df6f
BLAKE2b-256 f7faf5effc7f21392581586976c5baac39005db6c754fff35051c16701554e80

See more details on using hashes here.

File details

Details for the file rasterio-1.1.6-cp35-cp35m-macosx_10_9_intel.whl.

File metadata

  • Download URL: rasterio-1.1.6-cp35-cp35m-macosx_10_9_intel.whl
  • Upload date:
  • Size: 17.4 MB
  • Tags: CPython 3.5m, macOS 10.9+ intel
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp35-cp35m-macosx_10_9_intel.whl
Algorithm Hash digest
SHA256 3051973bbede9475d4c88c9752e8fd33457d4da02212c788d1d12513d4604e97
MD5 99480af22fbe9933fea4f71fb93098e7
BLAKE2b-256 ee6bc7eb34d0074f6e1fc4608eb803108c219ec9dde32a968f1a5e010c4780e7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.1.6-cp27-cp27mu-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.2 MB
  • Tags: CPython 2.7mu
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.1.6-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 bf172341db4cf4122d9b72a46296d1c4ca621b210c8d09d90475671f43e69a97
MD5 2148f4cf7bb23e88f27a37162c950c8f
BLAKE2b-256 87360d07d1d3225fdd574648ed8a51e0b3f79c2218f939b142d16041622079d6

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