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://mapbox.github.io/rasterio/.

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.

Dependencies

Rasterio has a C library dependency: GDAL >=1.9. 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 upgrade
$ 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.

Development and Testing

See CONTRIBUTING.rst.

Documentation

See docs/.

License

See LICENSE.txt.

Authors

See AUTHORS.txt.

Changes

See CHANGES.txt.

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

Uploaded Source

Built Distributions

rasterio-1.0a8-cp36-cp36m-manylinux1_x86_64.whl (41.8 MB view details)

Uploaded CPython 3.6m

rasterio-1.0a8-cp36-cp36m-macosx_10_6_intel.whl (18.6 MB view details)

Uploaded CPython 3.6m macOS 10.6+ intel

rasterio-1.0a8-cp35-cp35m-manylinux1_x86_64.whl (41.7 MB view details)

Uploaded CPython 3.5m

rasterio-1.0a8-cp35-cp35m-macosx_10_6_intel.whl (18.6 MB view details)

Uploaded CPython 3.5m macOS 10.6+ intel

rasterio-1.0a8-cp34-cp34m-manylinux1_x86_64.whl (41.8 MB view details)

Uploaded CPython 3.4m

rasterio-1.0a8-cp34-cp34m-macosx_10_6_intel.whl (18.7 MB view details)

Uploaded CPython 3.4m macOS 10.6+ intel

rasterio-1.0a8-cp27-cp27mu-manylinux1_x86_64.whl (41.4 MB view details)

Uploaded CPython 2.7mu

rasterio-1.0a8-cp27-cp27m-manylinux1_x86_64.whl (41.4 MB view details)

Uploaded CPython 2.7m

rasterio-1.0a8-cp27-cp27m-macosx_10_6_intel.whl (18.7 MB view details)

Uploaded CPython 2.7m macOS 10.6+ intel

File details

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

File metadata

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

File hashes

Hashes for rasterio-1.0a8.tar.gz
Algorithm Hash digest
SHA256 b29c54a543a4e4e4a8331a0bfcfac049bdd6ee36659cdb01cbffa62e040fb757
MD5 57105857182d15f1c7a89d1a0e2402d0
BLAKE2b-256 4518d016b060279e3879226db7842aefc48b95418c22dc8808790096cd340837

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0a8-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 cea896ac188b64dde681e97214f5c6cc3db26bce157d5a124024bfd0f517562c
MD5 448ba5f359dee5957a47752958916cca
BLAKE2b-256 48c9ec81ed86caa3110a76ddc7cd035a41a56042761189683e7c5da11952950d

See more details on using hashes here.

File details

Details for the file rasterio-1.0a8-cp36-cp36m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for rasterio-1.0a8-cp36-cp36m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 d9108b78c292096ed89f3629611a11e730f66503642b21381acf006e038aace5
MD5 45a0005a3a621c9ed1110ace56ef8c1d
BLAKE2b-256 4b61b0cdcb8ff3d134aefba58ac91d3c6ce4d37400473314e443da686b4f397a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0a8-cp35-cp35m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 af9d83bdedc2c4bfa35c04506dc38cf6d87b073293335f12ffb8df3882720de1
MD5 c0059129d3df09d594d6589eebb042a4
BLAKE2b-256 2f44fc2ad5d7c25c6c0068134bba7b451f8f8ff1a1f20e9670d2f4653e378ca5

See more details on using hashes here.

File details

Details for the file rasterio-1.0a8-cp35-cp35m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for rasterio-1.0a8-cp35-cp35m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 8bcb8fbb323d6f74fe36afe7af59cd23dbf5d4566dad2e92e5568a5927d329c3
MD5 a0eeb66001d59ad6eb25639926b8b9ae
BLAKE2b-256 63df2046dd5ddae52ecde0dd8a2333a122e867bcdf81def1cbb4518a81f219f1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0a8-cp34-cp34m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 e05de91f71687515bda7e120dbed31a8a589a8cfeb1382e7bb92aacae00e856b
MD5 f2cf6375db28affdd422f59879e129fd
BLAKE2b-256 3cf0501b58958b3ee3193f7e73fab26b318e161751761f34529014a1026bc9d3

See more details on using hashes here.

File details

Details for the file rasterio-1.0a8-cp34-cp34m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for rasterio-1.0a8-cp34-cp34m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 6a4779c6a23600702c00d02f1faa83298d54a51d6a77a585d787e04a50f2348d
MD5 186f35d3558b1af58c6ec636f7c7ae06
BLAKE2b-256 9f0bcb7d06c69f111d7800504955b7859da47d95a6210534bc9420040804411b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0a8-cp27-cp27mu-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 515fcaec69578eb4d04b530446c87782cdca94d2ddbd99a72ae706341362da9d
MD5 7ad56e664de3ea42a44eff375fd2d632
BLAKE2b-256 737d8b09feb51ffa7c8e2d81db95cb7ca713b268a1955e0c7d602fd19faa00ae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.0a8-cp27-cp27m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 be7e85593e33479ddc9aa1139e2db5c6abfd529a74976fe3fa35ca5b0dbb96a1
MD5 53fbe2ea8cc9b2369fbc6b814dc8a976
BLAKE2b-256 39893a4069f99893e3c630bec8a8814f2c11f8572673725a5e3e0539b2f28c98

See more details on using hashes here.

File details

Details for the file rasterio-1.0a8-cp27-cp27m-macosx_10_6_intel.whl.

File metadata

File hashes

Hashes for rasterio-1.0a8-cp27-cp27m-macosx_10_6_intel.whl
Algorithm Hash digest
SHA256 5c714e55bc9bb9ac5ff761c30fda8f85822da4eb58eb6fa6d0a13c32679fbd83
MD5 d38761a23ca18a23e12d780f9aed012a
BLAKE2b-256 474036f76739c212971ffe1645df6f57ca294e582d9bb29f6c2c6621e11fd111

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