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.com/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.1 works with Python versions 2.7 and 3.5 through 3.8, and GDAL versions 1.11 through 3.0. Official binary packages for Linux and Mac OS X are available on PyPI. Unofficial binary packages for Windows are available through other channels.

GDAL Compatibility:

  • Rasterio ~= 1.2.0 requires GDAL >= 3.0

  • Rasterio ~= 1.1.0 requires GDAL >= 1.11, < 3.3

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-binary 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. You will also need to specify the installed gdal version through the GDAL_VERSION environment variable.

$ python setup.py build_ext -I<path to gdal include files> -lgdal_i -L<path to gdal library> install

With pip

$ pip install --no-use-pep517 --global-option -I<path to gdal include files> -lgdal_i -L<path to gdal library> .

Note: --no-use-pep517 is required as pip currently hasn’t implemented a way for optional arguments to be passed to the build backend when using PEP 517. See here. for more details.

Alternatively environment variables (e.g. INCLUDE and LINK) used by MSVC compiler can be used to point to include directories and library files.

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.2b1.tar.gz (2.2 MB view details)

Uploaded Source

Built Distributions

rasterio-1.2b1-cp39-cp39-manylinux1_x86_64.whl (18.8 MB view details)

Uploaded CPython 3.9

rasterio-1.2b1-cp39-cp39-macosx_10_9_x86_64.whl (20.2 MB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

rasterio-1.2b1-cp38-cp38-manylinux1_x86_64.whl (18.8 MB view details)

Uploaded CPython 3.8

rasterio-1.2b1-cp38-cp38-macosx_10_9_x86_64.whl (20.2 MB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

rasterio-1.2b1-cp37-cp37m-manylinux1_x86_64.whl (18.8 MB view details)

Uploaded CPython 3.7m

rasterio-1.2b1-cp37-cp37m-macosx_10_9_x86_64.whl (20.2 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

rasterio-1.2b1-cp36-cp36m-manylinux1_x86_64.whl (18.8 MB view details)

Uploaded CPython 3.6m

rasterio-1.2b1-cp36-cp36m-macosx_10_9_x86_64.whl (20.2 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

Details for the file rasterio-1.2b1.tar.gz.

File metadata

  • Download URL: rasterio-1.2b1.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1.tar.gz
Algorithm Hash digest
SHA256 9e9701096bbefd1a414310d1485346d41be159f212079a65eebac7156f335982
MD5 0dcda578c73600989608ca5a3509b69a
BLAKE2b-256 e5f67aff05c06a28e49d2e3fc5f8074ddbeede9325f3900b10354eea7a9b9643

See more details on using hashes here.

File details

Details for the file rasterio-1.2b1-cp39-cp39-manylinux1_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2b1-cp39-cp39-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.8 MB
  • Tags: CPython 3.9
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1-cp39-cp39-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 ddad9edc92f097bef23355dca0f56a6cb21f8586961b0475127a7f01af299b61
MD5 8c77951fb63ef3c6ef270c419c12c16f
BLAKE2b-256 590a4fe2367d9318f9be8b6f05307cdd8bfffda71e31a96249a14510e74be5bf

See more details on using hashes here.

File details

Details for the file rasterio-1.2b1-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2b1-cp39-cp39-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 20.2 MB
  • Tags: CPython 3.9, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 6460b9a879d5d4565668bd2f9aabae234608702bf51e74cd94195e34a0df0b1b
MD5 9213b107e6b6522dab566ece6a5c2f6f
BLAKE2b-256 a38f87d685e30353447151a1c6ca1105033ac4a997b499dde01cd71c7e021720

See more details on using hashes here.

File details

Details for the file rasterio-1.2b1-cp38-cp38-manylinux1_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2b1-cp38-cp38-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.8 MB
  • Tags: CPython 3.8
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1-cp38-cp38-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 1a6e6c013fa1dda9fe5ee6a7cf2d7bc0a42c6681d0d731318bfa824ea15ac084
MD5 f0279e4d52d843e605ba38933c39b11e
BLAKE2b-256 56ac740ae84fd114081ec2d1ee6d35bb71907ee3842ca71fd8709c67635655a8

See more details on using hashes here.

File details

Details for the file rasterio-1.2b1-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2b1-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 20.2 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 17d639a307b7e57f0a757c01f75d45c1b8d5900c1f3502112755cd8f8c2f0bd5
MD5 1960d03434a863cd6457df4fe69fcbcc
BLAKE2b-256 b9807cde285a310ee48664e3489b5387cf55ec0d15495fa977cd33375f4d1c19

See more details on using hashes here.

File details

Details for the file rasterio-1.2b1-cp37-cp37m-manylinux1_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2b1-cp37-cp37m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.8 MB
  • Tags: CPython 3.7m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 52b5ce0054472615eb837b372d511bdf8b04a2c47ca666cb28d794092d02dcb4
MD5 4147886824b77dbfd53adcc08effe18d
BLAKE2b-256 065fb27a6b3db32dc057006bd030c495656d052a2babc642c11323e2d3b8b032

See more details on using hashes here.

File details

Details for the file rasterio-1.2b1-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2b1-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 20.2 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 83c7b8c1a8041f1f4d777eec32d59f9be31dc2bee4cd073ca9387e7fd179b70f
MD5 eeb78b43cdb1564497e0914f96f71c4d
BLAKE2b-256 2b55aff16698ac796e2adcd77bf54dd853b9a9e65a602f80cbcfada03f834ee1

See more details on using hashes here.

File details

Details for the file rasterio-1.2b1-cp36-cp36m-manylinux1_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2b1-cp36-cp36m-manylinux1_x86_64.whl
  • Upload date:
  • Size: 18.8 MB
  • Tags: CPython 3.6m
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm Hash digest
SHA256 cff3eb99e118a169ce3e44d271fb12e5944e9215cfe16dd611500eaa41173467
MD5 9946801b775cd2f58d5dbda96a23f0e4
BLAKE2b-256 c04484b387f71a7fac10328ca06792d09168aafad6f9b0a31cbb2a61e28e5adf

See more details on using hashes here.

File details

Details for the file rasterio-1.2b1-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: rasterio-1.2b1-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 20.2 MB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.5

File hashes

Hashes for rasterio-1.2b1-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 c522b3c036c5526d7bc9817a1c468077017552ecc673cdacf00ecd8b1c142289
MD5 a22c0a68a4d61e06b73716903997c849
BLAKE2b-256 e73e32e7d9b67082ad047f5b7c48ac9aad90c5b13258f03c03e61eb34a7e2903

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