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

Uploaded Source

Built Distributions

rasterio-1.0.16-cp37-cp37m-manylinux1_x86_64.whl (19.6 MB view details)

Uploaded CPython 3.7m

rasterio-1.0.16-cp37-cp37m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl (26.6 MB view details)

Uploaded CPython 3.7m macOS 10.10+ intel macOS 10.10+ x86-64 macOS 10.6+ intel macOS 10.9+ intel macOS 10.9+ x86-64

rasterio-1.0.16-cp36-cp36m-manylinux1_x86_64.whl (19.6 MB view details)

Uploaded CPython 3.6m

rasterio-1.0.16-cp36-cp36m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl (26.7 MB view details)

Uploaded CPython 3.6m macOS 10.10+ intel macOS 10.10+ x86-64 macOS 10.6+ intel macOS 10.9+ intel macOS 10.9+ x86-64

rasterio-1.0.16-cp35-cp35m-manylinux1_x86_64.whl (19.6 MB view details)

Uploaded CPython 3.5m

rasterio-1.0.16-cp35-cp35m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl (26.5 MB view details)

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

rasterio-1.0.16-cp34-cp34m-manylinux1_x86_64.whl (19.6 MB view details)

Uploaded CPython 3.4m

rasterio-1.0.16-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 (26.5 MB view details)

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

rasterio-1.0.16-cp27-cp27mu-manylinux1_x86_64.whl (19.6 MB view details)

Uploaded CPython 2.7mu

rasterio-1.0.16-cp27-cp27m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl (26.6 MB view details)

Uploaded CPython 2.7m macOS 10.10+ intel macOS 10.10+ x86-64 macOS 10.6+ intel macOS 10.9+ intel macOS 10.9+ x86-64

File details

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

File metadata

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

File hashes

Hashes for rasterio-1.0.16.tar.gz
Algorithm Hash digest
SHA256 8010425eb7804cfa3785ae2f59ddcd9f8de51d03516719d084e84e80c89ee955
MD5 5f76c49b3469278f04ff897423498ee3
BLAKE2b-256 ee8129b30295af0cd7fddb3a0c4b2fc6c57ac0571e1d33c88c340e8cd53da25b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.0.16-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.6 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.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.0.16-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 ecc324e22dc298a3fe26646a60a3cd33bf9c17bfa2afe15b15e442f9e1889c04
MD5 3855117cd7f173084da799d61d360d23
BLAKE2b-256 ac600c612fe5a49315aab4291ef1484307f73d73dc257d002a05ee2d460d9d46

See more details on using hashes here.

File details

Details for the file rasterio-1.0.16-cp37-cp37m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.16-cp37-cp37m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Algorithm Hash digest
SHA256 f08d19fe38b2480d1766b44d5e74463e8ca5508a862c14415c234a484f60537a
MD5 3f3d1b59b1dc1ddeef4ad0c94a0434a5
BLAKE2b-256 9db20b62f422ae4c151fe54e073ab89c9fa9e3ca04ede01328571342d4084976

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.0.16-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.6 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.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.0.16-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 8628389d7bd56a2c1ba6f4628e5382b106ee4043966dce9f7be9b151dc943cc3
MD5 70f664d9bf04de69d3994463827d2d31
BLAKE2b-256 5671c1ce5c6e0674347c81933ac9a989dd5c0c9f10eb811b69fdc08c84ce8206

See more details on using hashes here.

File details

Details for the file rasterio-1.0.16-cp36-cp36m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.16-cp36-cp36m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Algorithm Hash digest
SHA256 17f2582d928e0cd9057ed4588a333ad6c453549d2cfec068d1972b6c4260c922
MD5 48f9af1ee5b102c367f765a12521ed41
BLAKE2b-256 6ff6205c5a8854ecbd2aad4854fa2618ee352f116876a0aee4e2b757ca9284fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.0.16-cp35-cp35m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.6 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.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.0.16-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 cc90656e1fe05b74a4296d7e15932bfd3a23834a24b9f2009ba949c6ca2ed274
MD5 cdd84f2809e37381c764fcac4202aa0d
BLAKE2b-256 9253629608fdc6e4711774fb58a061aa0ac70d6c225c36bb9ff8d7b00065fde7

See more details on using hashes here.

File details

Details for the file rasterio-1.0.16-cp35-cp35m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.16-cp35-cp35m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Algorithm Hash digest
SHA256 a6db2bb1b000c5f1acb94d6e451f057d64961b1ab1310f430be828958da58d94
MD5 4102352681edf09c738da97b2bd27652
BLAKE2b-256 da170d48fae19d5fa5f92d7d10ff0ab97d50a1875194a85ea1442f659b34ba84

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.0.16-cp34-cp34m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.6 MB
  • Tags: CPython 3.4m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.0.16-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 2280687d5386cdc4c7a642fced71f7174dbb420ab833490c412c840111ca7649
MD5 2265809f7ea3f8c31b24b528d1ff5c01
BLAKE2b-256 0a36fed87f54d6552cd0a226a73160c7e4b7bc48907f00b684f7eef3db5da319

See more details on using hashes here.

File details

Details for the file rasterio-1.0.16-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.

File metadata

File hashes

Hashes for rasterio-1.0.16-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
Algorithm Hash digest
SHA256 1dc84b3c472bbc51f6ab1ca571633d19ba48b000df99afebc2067fe1c8199332
MD5 a394830181e5702be0d13f5d5970f8c6
BLAKE2b-256 38234ee58c4b6a425c97c82acee9df0ecb6e5731745109d726d1dcbfd226068c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.0.16-cp27-cp27mu-manylinux1_x86_64.whl
  • Upload date:
  • Size: 19.6 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.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for rasterio-1.0.16-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 e92b34e36459a4e2a39e83cbc02b389efcb2f44a4d5118c5d610ffc77a10f80f
MD5 7030f77fece5fe050b78182523ea8953
BLAKE2b-256 4b219ee246c4e780676b6b5f2204703c68b5dbd8f4e72b40df40c0c9eb623b66

See more details on using hashes here.

File details

Details for the file rasterio-1.0.16-cp27-cp27m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.0.16-cp27-cp27m-macosx_10_6_intel.macosx_10_9_intel.macosx_10_9_x86_64.macosx_10_10_intel.macosx_10_10_x86_64.whl
Algorithm Hash digest
SHA256 81d1feeeb87e9ce7cd75ad5ba3adef68a561ef4b37167cfcd80ea85cac16d393
MD5 7945cf840952190cfc6afd1ec8bdf43b
BLAKE2b-256 a65c564b826778cbf5eaf47fed2631306e143507f093a96fbf58d2fc1cbe3daa

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