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://app.travis-ci.com/rasterio/rasterio.svg?branch=master https://coveralls.io/repos/github/mapbox/rasterio/badge.svg?branch=master https://img.shields.io/pypi/v/rasterio

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.3 works with Python 3.8+, Numpy 1.18+, and GDAL 3.1+. Official binary packages for Linux, macOS, and Windows with most built-in format drivers plus HDF5, netCDF, and OpenJPEG2000 are available on PyPI. Unofficial binary packages for Windows are available through other channels.

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 read/write windows (like extended array slices) given georeferenced coordinates.

with rasterio.open('tests/data/RGB.byte.tif') as src:
    window = src.window(*src.bounds)
    print(window)
    print(src.read(window=window).shape)

# Printed:
# Window(col_off=0.0, row_off=0.0, width=791.0000000000002, height=718.0)
# (3, 718, 791)

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 >= 3.1. GDAL itself depends on some other libraries provided by most major operating systems and also depends on the non standard GEOS and PROJ libraries. How to meet these requirement will be explained below.

Rasterio’s Python dependencies are (see the package metadata file):

affine
attrs
certifi
click>=4.0
cligj>=0.5
numpy>=1.18
snuggs>=1.4.1
click-plugins
setuptools

[all]
hypothesis
pytest-cov>=2.2.0
matplotlib
boto3>=1.2.4
numpydoc
pytest>=2.8.2
shapely
ipython>=2.0
sphinx
packaging
ghp-import
sphinx-rtd-theme

[docs]
ghp-import
numpydoc
sphinx
sphinx-rtd-theme

[ipython]
ipython>=2.0

[plot]
matplotlib

[s3]
boto3>=1.2.4

[test]
boto3>=1.2.4
hypothesis
packaging
pytest-cov>=2.2.0
pytest>=2.8.2
shapely

Development requires Cython and other packages.

Binary Distributions

Use a binary distribution that directly or indirectly provides GDAL if possible.

The rasterio wheels on PyPI include GDAL and its own dependencies.

Rasterio

GDAL

1.2.3

3.2.2

1.2.4+

3.3.0

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.9+. 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, adjusting for your Python version.

$ pip install -U pip
$ pip install GDAL-3.1.4-cp39-cp39‑win_amd64.whl
$ pip install rasterio‑1.1.8-cp39-cp39-win_amd64.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

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 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.

Development and Testing

See CONTRIBUTING.rst.

Documentation

See docs/.

License

See LICENSE.txt.

Authors

The rasterio project was begun at Mapbox and was transferred to the rasterio Github organization in October 2021.

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.3.8.tar.gz (412.4 kB view details)

Uploaded Source

Built Distributions

rasterio-1.3.8-cp311-cp311-win_amd64.whl (22.9 MB view details)

Uploaded CPython 3.11 Windows x86-64

rasterio-1.3.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (21.3 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

rasterio-1.3.8-cp311-cp311-macosx_11_0_arm64.whl (19.5 MB view details)

Uploaded CPython 3.11 macOS 11.0+ ARM64

rasterio-1.3.8-cp311-cp311-macosx_10_15_x86_64.whl (22.8 MB view details)

Uploaded CPython 3.11 macOS 10.15+ x86-64

rasterio-1.3.8-cp310-cp310-win_amd64.whl (22.9 MB view details)

Uploaded CPython 3.10 Windows x86-64

rasterio-1.3.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (21.3 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

rasterio-1.3.8-cp310-cp310-macosx_11_0_arm64.whl (19.5 MB view details)

Uploaded CPython 3.10 macOS 11.0+ ARM64

rasterio-1.3.8-cp310-cp310-macosx_10_15_x86_64.whl (22.8 MB view details)

Uploaded CPython 3.10 macOS 10.15+ x86-64

rasterio-1.3.8-cp39-cp39-win_amd64.whl (23.0 MB view details)

Uploaded CPython 3.9 Windows x86-64

rasterio-1.3.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (21.3 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

rasterio-1.3.8-cp39-cp39-macosx_11_0_arm64.whl (19.5 MB view details)

Uploaded CPython 3.9 macOS 11.0+ ARM64

rasterio-1.3.8-cp39-cp39-macosx_10_15_x86_64.whl (22.9 MB view details)

Uploaded CPython 3.9 macOS 10.15+ x86-64

rasterio-1.3.8-cp38-cp38-win_amd64.whl (23.0 MB view details)

Uploaded CPython 3.8 Windows x86-64

rasterio-1.3.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (21.3 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

rasterio-1.3.8-cp38-cp38-macosx_11_0_arm64.whl (19.5 MB view details)

Uploaded CPython 3.8 macOS 11.0+ ARM64

rasterio-1.3.8-cp38-cp38-macosx_10_15_x86_64.whl (22.8 MB view details)

Uploaded CPython 3.8 macOS 10.15+ x86-64

File details

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

File metadata

  • Download URL: rasterio-1.3.8.tar.gz
  • Upload date:
  • Size: 412.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for rasterio-1.3.8.tar.gz
Algorithm Hash digest
SHA256 ffdd18e78efdf8ad5861065fd812a66dd34264293317ff6540a078ea891cdef8
MD5 2578f92b5be4f9f5f2426333717bece7
BLAKE2b-256 2e2e65affa3bd9c6c8f4a3b4f7cbf7947d0a3b3a65675af58162f80201c01510

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp311-cp311-win_amd64.whl.

File metadata

  • Download URL: rasterio-1.3.8-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 22.9 MB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for rasterio-1.3.8-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 0323332ed1bfad522e53a3da45e0d3453e603862c3d2c08d8a639a7be76853fb
MD5 861662e2961ed570694fa7b5767354da
BLAKE2b-256 03961a35b15183bdc9c6a19e08cd92b5ebb201a9c76ec24c3f17a714202c5d2b

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 0b8e1b456f58b9ae023026730320424091af504ef066418ddcd296b9014845ee
MD5 71808b38c40e82f3de12b875e3e70fb8
BLAKE2b-256 7c5d6fb859b5df963b3213da844fe6c24065fc9d20e3a47146dd0454efa7021e

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b3b8410be847e8fd96cbe744e28e484437b370830052b5dcc7b11efc8c73fffc
MD5 6c948df0c45e82721983450f95248f29
BLAKE2b-256 9f47320376453d416461e5d16101cdebdaae019b59ce5a169ce855c6ea7fd560

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp311-cp311-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp311-cp311-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 d5ccc8e6d30534d510ce5099d4a35616611cadcae79aa1216150c2696e03ddde
MD5 0f5472a458f98d92ffe36494452e9e67
BLAKE2b-256 792c16b7c4feb71b8e56d79e831ae26001e3e699c9f3c279fb5cb4b17e7d8c64

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: rasterio-1.3.8-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 22.9 MB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for rasterio-1.3.8-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 ce5c3193b141d23fe081e6b97665f072af48556622da6ae4d45d3a2192e38c3f
MD5 8445dd3419b4816706f2076832b31c84
BLAKE2b-256 8b709b17ba2281a1ed2ec0d09e816b38ea8443774474a8e94aff1c4aaf51cd95

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 15ec3bfc55c793d1dc7437f3d8b55116db5ea1cf4e0c25c96999fd99daf1ae6f
MD5 8449be8a2666897b448fd6d05967146b
BLAKE2b-256 c87e08d80abba94a41a6102b432897fe21e99896120fad2766b4875bfc06a8d2

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 2e2207003854af60a879cdd87da033cbf86a53585dbf2a49045f66decc3bbb01
MD5 254264593bd1fdca74e340bf82423a3a
BLAKE2b-256 2141aef6108ee3be520166e87d23daf20a877303398a685cab26f5387ec3a5d7

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp310-cp310-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp310-cp310-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 fea5db183fd1c85e7f41651af5b474af09a68a5e12ce37cad8cc7708843f1ea4
MD5 e5d8910b305e86c44d42b8ee282f1e1f
BLAKE2b-256 18dead64fd3ec339ac51d983c861073cf67078a04dba008d5aa0835685b2a1a2

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: rasterio-1.3.8-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 23.0 MB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for rasterio-1.3.8-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 3b654e9fd64ad1f68699376a25bd1b403f8b023a75af42e3b26effda990428df
MD5 013fcb7136bc4b5840753e7cf1837680
BLAKE2b-256 438f62178ad14e3f9823504753f75fa534f5aef7255e0461945c86fd5cb33db9

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c6c466b2b7a49f8ab3ee0ad0974185b806b7c19427dbf3e1cf4372ce0d52b2ee
MD5 20ca133b9a575348d7ad12f2e3c12e7e
BLAKE2b-256 3d0469dacdc33a9fae1c425a139c80f26ae90bc60cb1f57c506ba353ff155f8c

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp39-cp39-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f57d73b5713d8096ec2fc9bb929bf3ce995f3f34d95e32f30192d180921d341a
MD5 6fb27e65d51e8a8cb7ae373969df531f
BLAKE2b-256 523681a1e970669a5529a2972d97067df7eabb8085678121afaccac0daa0c7a3

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp39-cp39-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp39-cp39-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 4c9451f51e175940223ad2d3b205a303a810f5d396fbaf0f17fbde6ee1b74737
MD5 74d310fa6da20686230f79da5cc2d4f8
BLAKE2b-256 917716ef64871868ba19cf0213f2cae66ac94bdd764e07d8db328f07545b1373

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: rasterio-1.3.8-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 23.0 MB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for rasterio-1.3.8-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 d184ad8d29c9c8a04d265cdc229d446c59b142d36228926a17767c1758469c8a
MD5 5022c4d0a3042513e9546cdf41dbe1fb
BLAKE2b-256 b9053fefd9e7ed91171d61a69a82306d26898772daaf65abcafd4087f85542ad

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 eefa29a8d5dfd6537fee6e7f28be7b78ceedb85026851c58759563ef7541dc0c
MD5 68a1a8729cf9d17794a5853e8fbd6044
BLAKE2b-256 c117f408777ddee5f5df4fb2e2fe5eddf90471df977ef91adc9e9ac5ea491610

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp38-cp38-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp38-cp38-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 969b943d3746bad7cc9e2433deb4d21a6f0b21a5b46daeb95530b79fe010910b
MD5 7de03a86375af32dc39647b1283429aa
BLAKE2b-256 c649c20bfa977337b1a8b0aaad3bf6c29e207f1391c8798c5ec98905644e04b1

See more details on using hashes here.

File details

Details for the file rasterio-1.3.8-cp38-cp38-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for rasterio-1.3.8-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 d177157a9a033a0642b3102d9f9e169bada56f1e25c982d2549359a3f397dcff
MD5 f29dec0ebf35fedf7c597c4707d46ae2
BLAKE2b-256 7e779d797be2b269052c20317484b9465795033f27062c845e69092dadd9bbc1

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