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

Uploaded Source

Built Distributions

rasterio-1.3.7-cp311-cp311-win_amd64.whl (23.0 MB view details)

Uploaded CPython 3.11 Windows x86-64

rasterio-1.3.7-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.7-cp311-cp311-macosx_11_0_arm64.whl (19.5 MB view details)

Uploaded CPython 3.11 macOS 11.0+ ARM64

rasterio-1.3.7-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.7-cp310-cp310-win_amd64.whl (23.1 MB view details)

Uploaded CPython 3.10 Windows x86-64

rasterio-1.3.7-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.7-cp310-cp310-macosx_11_0_arm64.whl (19.5 MB view details)

Uploaded CPython 3.10 macOS 11.0+ ARM64

rasterio-1.3.7-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.7-cp39-cp39-win_amd64.whl (23.1 MB view details)

Uploaded CPython 3.9 Windows x86-64

rasterio-1.3.7-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.7-cp39-cp39-macosx_11_0_arm64.whl (19.5 MB view details)

Uploaded CPython 3.9 macOS 11.0+ ARM64

rasterio-1.3.7-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.7-cp38-cp38-win_amd64.whl (23.1 MB view details)

Uploaded CPython 3.8 Windows x86-64

rasterio-1.3.7-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.7-cp38-cp38-macosx_11_0_arm64.whl (19.5 MB view details)

Uploaded CPython 3.8 macOS 11.0+ ARM64

rasterio-1.3.7-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.7.tar.gz.

File metadata

  • Download URL: rasterio-1.3.7.tar.gz
  • Upload date:
  • Size: 411.7 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.7.tar.gz
Algorithm Hash digest
SHA256 abfdcb8f10210b8fad939f40d545d6c47e9e3b5cf4a43773ca8dd11c58204304
MD5 c62e4db53a9c892b2114c217f43e203d
BLAKE2b-256 7bd87590109d7a62af60754c406ebf67c55f9646919a40096c5373d0f67bb525

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.3.7-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 23.0 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.7-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 e3c06f1a62b28437c908851f0fc67abc6b31fce4a535e88e92311e73b8709996
MD5 83d68e281c32c6649e4eece0e86e29dd
BLAKE2b-256 de2e6681cb4d029cbeb67964a90b07d9691d6982ac5a30c2c92bcefbd1c8b30d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 feebf547b6785d57330f9ef69af54534a9548b24510c4e2fe87e5b9355112c28
MD5 95bec801bba011266c12cd0b20a0c507
BLAKE2b-256 31df1f746d2ac326b922b22e85c232cb494cb7f1d23051d4777ab261146a8248

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 41f233b7c85a74d66da4e31e37cfabe3c1aa116260063519d49f266e278bd4b3
MD5 57bca2b8964a4cf8ea005ac7be3de57b
BLAKE2b-256 237c352fc63067b2f3d32175d48c026c6f47f06d707cbd98ed04b65d6e43444d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp311-cp311-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 d6fa64dfda2ce1fe4c8b4e61d6e476ab3f389ac679e49b5386bb83708939a1b2
MD5 f04d332bda6ac0b821bf9436281ad84a
BLAKE2b-256 8975c05b09dc401d48d18309a969310e49e6b6519a0aa81dea541fb31831f241

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.3.7-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 23.1 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.7-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 a8013826cdf540fb4f1507f92bb4ef440b594a4a8895d9038e25498e5b135f52
MD5 a7dbebd4dc41215d56388e417321d04f
BLAKE2b-256 2a4baf3d2222ed3a22715996ebeaed584f72d91962695c3e942d2de523eaeb6f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 075731165d26ef33e33e3ab903a0ecabb643893794bea1c78dd6c631713d1820
MD5 a873e2f97367bf6400ab8fc2ffa77ba1
BLAKE2b-256 9040d768d5eb5fe8955e56c20cbd51ca19773becb76ef67338a06df24ae344b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 baab6f3ba468d3b3ada05b282574af0f3110830f50888948d50c1f16aa6130af
MD5 8b7d206e6e38d8c2ca8278caba4d5847
BLAKE2b-256 66b79f3d9bb69498e4cc77cb1311953c7667abe1016157ac2cc71137c092283c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp310-cp310-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 106e6519f5d2a0d35f0e963a8d07dc313ba7f6595a4c89fe9d6dcd8662a86617
MD5 fe52c1b922a1c0764cc09861d4904d2e
BLAKE2b-256 3f7448dc37943289b2290621cd80b5c48cc7ce6051c367869a9c74cdce527dc2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.3.7-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 23.1 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.7-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 a97610a2997d9dc246ccd3f1361fdd63ae0b23a676e68af4f018f03e8c8a7592
MD5 778e929c42fb2f9fb2ffadf1364f3caf
BLAKE2b-256 e2f9a95184a4547194a04319a10b0e9bb8ce97023182695c7327d9bfd57dd817

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 cd21347b58fb60f2f0a8f7eb95ce58680590e205dee80562a67e868eebaaeea5
MD5 b0e484ba552924732bbeaca6449791fc
BLAKE2b-256 614d21450bb4c070ee35c249827473ef8735eafdb2f4c8df05e2ccbfbfb6fd3f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c2ddc9cb2ccb0d296ca8c9da8af73b4d1c03c887a7dabbb4b4a6fa1e7450c1e7
MD5 5132140de769d0aa40ce0248a15dee36
BLAKE2b-256 088871e6a367cd7cd3723aeae1827299763f2cdf61c77591a22de1cb5efd8725

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp39-cp39-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 b4ad780117fefcd0fb81e2459d409a722f5964d1f655252278c7c56eb18f7ae6
MD5 bb7844948c29b24925dcdc4f6e2d350f
BLAKE2b-256 73f4786e9ccfde725054511ea86ca80e1c5c370024cd4c39272a9cb1f198b1c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rasterio-1.3.7-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 23.1 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.7-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 58d3d42cf06645f694911ea2707e6204868006784e0df3540e05e4615209b9c3
MD5 bc77d1ee76456b11ca0e2be588be1681
BLAKE2b-256 ca5adbf706422e7deb3c256c32ae23d9a3d7c28892b5062b2b1774798ca70f3a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c04a4932807ae64642f18d7c3f7cf504cb6703ec35496d07f2e5679ec5b9c4d3
MD5 0079db50ac640ceda6c8342e8ce707f5
BLAKE2b-256 251a2bf54ae4cfa2a18760edfbe3050ab446d9521c3c73c051d7d7699652e47f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp38-cp38-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ce334df60b9d6ea66751b03afd1d138a551d27f2588e95ac6d7479856bb575a8
MD5 48683c1d5386d73bfb747407eb8bb3c5
BLAKE2b-256 caa10b8f02525c1160db23bcdc6299575c47176e53494a756070b0df0c2deb0b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rasterio-1.3.7-cp38-cp38-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 5247affa7122f3c10a82d8cfa56b89fb60bfb981e4a22ebad8889d1caa138215
MD5 46bfb1c7e7b83a4d5a62c17df88a1448
BLAKE2b-256 5748eedcc953dbeeafab19b766205c5854bb26289e90ebe12225da6294c58f0f

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