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

Uploaded Source

Built Distributions

rasterio-1.0rc4-cp36-cp36m-manylinux1_x86_64.whl (18.7 MB view details)

Uploaded CPython 3.6m

rasterio-1.0rc4-cp36-cp36m-macosx_10_9_x86_64.whl (22.9 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

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

Uploaded CPython 3.5m

rasterio-1.0rc4-cp35-cp35m-macosx_10_9_intel.macosx_10_9_x86_64.whl (22.9 MB view details)

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

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

Uploaded CPython 3.4m

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

Uploaded CPython 2.7mu

rasterio-1.0rc4-cp27-cp27m-manylinux1_x86_64.whl (18.1 MB view details)

Uploaded CPython 2.7m

rasterio-1.0rc4-cp27-cp27m-macosx_10_9_x86_64.whl (23.0 MB view details)

Uploaded CPython 2.7m macOS 10.9+ x86-64

File details

Details for the file rasterio-1.0rc4.tar.gz.

File metadata

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

File hashes

Hashes for rasterio-1.0rc4.tar.gz
Algorithm Hash digest
SHA256 6fa82248dc6090c426b4acd913bfd5d61a41f8b70a74e02edf48f327bb797c40
MD5 14777fc98a2288f7321c91397a66fd56
BLAKE2b-256 a369b9b8bc3985db2504cffbc32a86d433e68f0d403d7ded64a1e81d49de7d68

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 3d230c764f86c9b4a54eb89fc9742f172c07f11861b070721e36444032a64afc
MD5 77c5379315757ce9ad880218029c5403
BLAKE2b-256 ebb5ed911771643be311d2abe17eb516994238dba9c10eabb2b887c25c3d10cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 b82c2946c3d080690b02f2575ae84021bf1109515ac0e9d21b051f78216f2aa8
MD5 630b3d9515634e327edb0eaf3838133c
BLAKE2b-256 df33f241d43321a682c09dd1aeadd276fe736170c2933b5c0dcb6909d2696e33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 15d02135db123f0f0ed1a92e45b7b22f9cbae561aef7cd53f4f01837b33cd6b4
MD5 967fde5c6e2f9466923a0c9eb9e7acda
BLAKE2b-256 8069a83a34749c82d1a97dde445a56f41217bcb63109b33bbf28a2e8a760f8b1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp35-cp35m-macosx_10_9_intel.macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 daef336c1b2e58fe10849dbe02d40bea95aa0940a20252b55e2e7851642e7132
MD5 ac9de88c2fc5c050eb37ae6219c9cd07
BLAKE2b-256 6a13731922f0ad7f14fd0dc954ada5b64f3601928058b4a3606b07914465d07a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 82ffd731db256a378f5776334e70919a0733d9b0eaac96a644409ccbf14f0ee1
MD5 490fa210058a22bf76d3a125c4f26330
BLAKE2b-256 ccd879a956d2e688a4346bf4cd433d461db038164ccb82e6f5f841afd00cb659

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp34-cp34m-macosx_10_9_intel.macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 7100b47130d8bc5ddcf4d017c94be13a685910a67a43324435da5e7477e9c448
MD5 baa8cf8b886d11fe67057a9959ff2e3c
BLAKE2b-256 c830629c42b5f6762737d876a206e85e2124369e0e099d5791e4da1f93574a99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 72d199e543d629375292899a7df6a183cf4eceb35f48b219556c61e647dc224d
MD5 43740cb407b6d1b5cd223c72521e2286
BLAKE2b-256 817f83b6f9f31768c30655b6c8f4153b054df1b14c5e574d54656787cc439bba

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 0d6b9b7c9c5a47ae622cf96ff143041917dc525587fff23c369c7a31bef76434
MD5 fdd752bd7a6e6abaa821fced1df3169f
BLAKE2b-256 a569c8e4ec772405051a85d0ba02362b4e9b06435b2af5a7d291d81c4ee6d870

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0rc4-cp27-cp27m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 e2c8d5fa58f26dd1c11497315b645075b5c0cb0a88536f87d96a5ada6be27389
MD5 7981ca22a58ff3960bba1b4afbaa2847
BLAKE2b-256 7958fa19254a3748f17b06905c9718a8357e6689f8dbac54a4ffb1a4a3f3d1f7

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