pyramids — GIS utilities for rasters, vectors & datacubes, built on GDAL/OGR

GitHub last commit GitHub Repo stars

GitHub commits since latest release (by SemVer including pre-releases)

Current release info

Name	Downloads	Version	Platforms

conda-forge feedstock

Conda-forge feedstock

pyramids - GIS utility package

pyramids is a GIS utility package built on top of GDAL/OGR for working with raster data (GeoTIFF, NetCDF), vector data (shapefiles, GeoJSON), and multi-temporal datacubes.

pyramids at a glance — every GDAL format, none of the boilerplate

pyramids-gis is licensed under GPLv3 (see LICENSE.md). The platform wheels published on PyPI bundle GDAL and its native dependencies (PROJ, GEOS, libtiff, NetCDF-C, HDF5, libcurl, …) — each under its own MIT, BSD, LGPL, or Apache license. The full attribution list and shipped license texts are documented in THIRD_PARTY_LICENSES.md; if you use pyramids-gis in publications please also cite GDAL itself per gdal.org/cite_gdal.html.

graph LR
    GeoTIFF & NetCDF & Shapefile & UGRID -->|read| pyramids
    subgraph pyramids
        direction TB
        Dataset
        NetCDF_class[NetCDF]
        UgridDataset
        DatasetCollection
        FeatureCollection
        subgraph Engines["Dataset engines (ds.io · ds.spatial · ds.bands · ds.analysis · ds.cell · ds.vectorize · ds.cog)"]
        end
        subgraph Plotting["Plotting layer — _plot_helpers.render_array · mesh_render · NetCDFPlot · Selectors / ColourOpts / FacetSpec · basemap"]
        end
    end
    Dataset -->|crop · reproject · align| Dataset
    Dataset --- Engines
    FeatureCollection -->|rasterize| Dataset
    UgridDataset -->|interpolate| Dataset
    Dataset -->|vectorize| FeatureCollection
    DatasetCollection -->|lazy temporal stack| Dataset
    NetCDF_class -->|extends| Dataset
    Dataset & NetCDF_class & DatasetCollection & UgridDataset -->|plot| Plotting
    Plotting -->|delegates| cleopatra(["cleopatra<br/>ArrayGlyph · MeshGlyph · tiles"])

For the class relationships, internal layers, and detailed architecture diagrams, see docs/overview/architecture.md.

Main Features

Dataset - Read, write, crop, reproject, and align single-band and multi-band rasters (GeoTIFF) with full no-data handling and coordinate reference system support. Public API is organized into seven engine collaborators (ds.io, ds.spatial, ds.bands, ds.analysis, ds.cell, ds.vectorize, ds.cog); same-named facade methods on the Dataset itself keep the short form working — ds.crop(mask) and ds.spatial.crop(mask) are equivalent.
NetCDF - Extends Dataset for NetCDF files with time/variable dimensions and CF conventions metadata. Optional labeled-array interoperability. NetCDF.plot exposes a labeled-array-style plotting API (variable= + grouped Selectors / ColourOpts / FacetSpec dataclasses, curvilinear coords=, kind=, animate=, lazy chunks=).
UgridDataset - Read and visualize UGRID-1.0 unstructured meshes (triangles, quads, mixed). Supports mesh-to-raster interpolation and mesh-to-vector export.
DatasetCollection - Manage time-series of co-registered rasters as a lazy temporal stack (per-timestep gdal handles open on demand; the full cube is never materialised in RAM) with optional dask-backed reductions and groupby.
FeatureCollection - Work with vector data (shapefiles, GeoJSON) through a unified GeoDataFrame and OGR DataSource interface, including rasterization and geometry operations.
Plotting - Dataset / NetCDF / DatasetCollection / UgridDataset all expose a plot method backed by cleopatra (the [viz] extra), routed through a shared pyramids.dataset._plot_helpers core. Optional web-tile basemap underlays via pyramids.basemap.add_basemap (a thin wrapper over cleopatra.tiles.add_tiles).
Cloud-Optimized GeoTIFF (COG) - First-class read/write/validate support via ds.to_cog, ds.is_cog, and ds.validate_cog.
Spatial operations - Align rasters to a reference grid, reproject between coordinate systems, crop to vector boundaries, and convert between raster, NetCDF, and vector formats.

Installing pyramids

Installing pyramids from the conda-forge channel can be achieved by:

conda install -c conda-forge pyramids

It is possible to list all the versions of pyramids available on your platform with:

conda search pyramids --channel conda-forge

Install from GitHub (development)

To install the latest development version, you can install the library from GitHub:

pip install git+https://github.com/serapeum-org/pyramids

Note: installing from GitHub uses the sdist and requires a pre-installed system GDAL. See the full installation guide and troubleshooting for details.

pip

To install the latest release from PyPI:

pip install pyramids-gis

Linux + pixi: no glibc pin needed anymore

pyramids-gis ships its Linux wheels tagged manylinux_2_28 (GDAL and its native stack are compiled from source with the manylinux toolchain). pixi's default Linux baseline is glibc 2.28 (it tracks conda-forge's floor), so the wheel resolves out of the box — no [tool.pixi.system-requirements] entry required (verified with pixi 0.65 defaults; newer versions, including the 0.68.1 this repo pins in CI, share the same baseline).

Two cases still need a pin in the consuming project's pyproject.toml / pixi.toml:

[tool.pixi.system-requirements]
libc = "2.39"    # only for the older releases that shipped manylinux_2_39 wheels (0.2x-0.39.x)

or libc = "2.28" if you run a pixi version old enough that its default baseline is still below 2.28. On Linux with glibc < 2.28, install from conda-forge instead. See the full installation guide and troubleshooting for the other cases.

Optional extras

pip install pyramids-gis[viz]      # cleopatra plotting support
pip install xarray                 # to_xarray / from_xarray / to_netcdf interop (peer dep, not an extra)

Quick start

from pyramids.dataset import Dataset

# Open a raster file
src = Dataset.read_file("path/to/raster.tif")
print(src.epsg)        # coordinate reference system EPSG code
print(src.cell_size)   # pixel resolution
print(src.shape)       # (bands, rows, columns)

# Read the raster data as a NumPy array
arr = src.read_array()                  # all bands
band0 = src.read_array(band=0)          # one band

# Spatial ops route through the spatial engine; the facade stays short
reprojected = src.to_crs(to_epsg=3857)  # same as src.spatial.to_crs(...)

from pyramids.netcdf import NetCDF
from pyramids import Selectors, ColourOpts, FacetSpec   # grouped plot options

# Open a NetCDF file
nc = NetCDF.read_file("path/to/data.nc")
print(nc.variables)

# labeled-array-style plotting (needs the [viz] extra)
nc.plot("t2m", selectors=Selectors(time="2020-07-01", level=850),
        colour=ColourOpts(cmap="coolwarm", robust=True))
nc.plot("t2m", facet=FacetSpec(col="time", col_wrap=4))   # small multiples
nc.plot("t2m", animate="time", chunks={"time": 1})        # lazy per-frame animation

from pyramids.feature import FeatureCollection

# Open a vector file
vector = FeatureCollection.read_file("path/to/shapefile.shp")
print(vector.epsg)            # CRS EPSG code
print(vector.total_bounds)    # (minx, miny, maxx, maxy)

from pyramids.dataset import DatasetCollection

# Build a lazy stack of co-registered rasters (no pixels read yet)
cube = DatasetCollection.from_files(["a.tif", "b.tif", "c.tif"])
print(cube.time_length, cube.shape)

# Reductions over the time axis use dask under the hood
mean = cube.mean()                       # nan-aware by default

Testing

This project uses pixi as the environment and task manager.

# Install dependencies and create dev environment
pixi install -e dev

# Run all tests (excluding plot tests)
pixi run -e dev main

# Run plot tests only
pixi run -e dev plot

# Run a specific test file
pixi run -e dev pytest tests/netcdf/test_dimensions.py -v

# Run a single test by node id
pixi run -e dev pytest tests/netcdf/test_dimensions.py::TestStripBraces::test_with_braces -q

Docker

A Dockerfile is provided to run pyramids-gis in a controlled environment with the correct GDAL stack preinstalled via conda-forge. The image uses a multi-stage pixi build for a minimal production container.

Build the image:

docker build -t pyramids-gis:latest .

Run the container (mount your current folder as /workspace):

docker run --rm -it -v ${PWD}:/workspace pyramids-gis:latest bash

Inside the container you can verify the package is installed:

python -c "import pyramids; print('pyramids', pyramids.__version__)"

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyramids_gis-0.57.0.tar.gz (1.0 MB view details)

Uploaded Aug 26, 2026 Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pyramids_gis-0.57.0-cp314-cp314-win_arm64.whl (26.9 MB view details)

Uploaded Aug 26, 2026 CPython 3.14Windows ARM64

pyramids_gis-0.57.0-cp314-cp314-win_amd64.whl (52.4 MB view details)

Uploaded Aug 26, 2026 CPython 3.14Windows x86-64

pyramids_gis-0.57.0-cp314-cp314-manylinux_2_28_x86_64.whl (32.0 MB view details)

Uploaded Aug 26, 2026 CPython 3.14manylinux: glibc 2.28+ x86-64

pyramids_gis-0.57.0-cp314-cp314-manylinux_2_28_aarch64.whl (30.5 MB view details)

Uploaded Aug 26, 2026 CPython 3.14manylinux: glibc 2.28+ ARM64

pyramids_gis-0.57.0-cp314-cp314-macosx_11_0_x86_64.whl (46.7 MB view details)

Uploaded Aug 26, 2026 CPython 3.14macOS 11.0+ x86-64

pyramids_gis-0.57.0-cp314-cp314-macosx_11_0_arm64.whl (43.6 MB view details)

Uploaded Aug 26, 2026 CPython 3.14macOS 11.0+ ARM64

pyramids_gis-0.57.0-cp313-cp313-win_arm64.whl (26.1 MB view details)

Uploaded Aug 26, 2026 CPython 3.13Windows ARM64

pyramids_gis-0.57.0-cp313-cp313-win_amd64.whl (50.7 MB view details)

Uploaded Aug 26, 2026 CPython 3.13Windows x86-64

pyramids_gis-0.57.0-cp313-cp313-manylinux_2_28_x86_64.whl (32.0 MB view details)

Uploaded Aug 26, 2026 CPython 3.13manylinux: glibc 2.28+ x86-64

pyramids_gis-0.57.0-cp313-cp313-manylinux_2_28_aarch64.whl (30.5 MB view details)

Uploaded Aug 26, 2026 CPython 3.13manylinux: glibc 2.28+ ARM64

pyramids_gis-0.57.0-cp313-cp313-macosx_11_0_x86_64.whl (46.7 MB view details)

Uploaded Aug 26, 2026 CPython 3.13macOS 11.0+ x86-64

pyramids_gis-0.57.0-cp313-cp313-macosx_11_0_arm64.whl (43.6 MB view details)

Uploaded Aug 26, 2026 CPython 3.13macOS 11.0+ ARM64

pyramids_gis-0.57.0-cp312-cp312-win_arm64.whl (26.1 MB view details)

Uploaded Aug 26, 2026 CPython 3.12Windows ARM64

pyramids_gis-0.57.0-cp312-cp312-win_amd64.whl (50.7 MB view details)

Uploaded Aug 26, 2026 CPython 3.12Windows x86-64

pyramids_gis-0.57.0-cp312-cp312-manylinux_2_28_x86_64.whl (32.0 MB view details)

Uploaded Aug 26, 2026 CPython 3.12manylinux: glibc 2.28+ x86-64

pyramids_gis-0.57.0-cp312-cp312-manylinux_2_28_aarch64.whl (30.5 MB view details)

Uploaded Aug 26, 2026 CPython 3.12manylinux: glibc 2.28+ ARM64

pyramids_gis-0.57.0-cp312-cp312-macosx_11_0_x86_64.whl (46.7 MB view details)

Uploaded Aug 26, 2026 CPython 3.12macOS 11.0+ x86-64

pyramids_gis-0.57.0-cp312-cp312-macosx_11_0_arm64.whl (43.6 MB view details)

Uploaded Aug 26, 2026 CPython 3.12macOS 11.0+ ARM64

pyramids_gis-0.57.0-cp311-cp311-win_amd64.whl (50.7 MB view details)

Uploaded Aug 26, 2026 CPython 3.11Windows x86-64

pyramids_gis-0.57.0-cp311-cp311-manylinux_2_28_x86_64.whl (32.0 MB view details)

Uploaded Aug 26, 2026 CPython 3.11manylinux: glibc 2.28+ x86-64

pyramids_gis-0.57.0-cp311-cp311-manylinux_2_28_aarch64.whl (30.5 MB view details)

Uploaded Aug 26, 2026 CPython 3.11manylinux: glibc 2.28+ ARM64

pyramids_gis-0.57.0-cp311-cp311-macosx_11_0_x86_64.whl (46.7 MB view details)

Uploaded Aug 26, 2026 CPython 3.11macOS 11.0+ x86-64

pyramids_gis-0.57.0-cp311-cp311-macosx_11_0_arm64.whl (43.6 MB view details)

Uploaded Aug 26, 2026 CPython 3.11macOS 11.0+ ARM64

File details

Details for the file pyramids_gis-0.57.0.tar.gz.

File metadata

Download URL: pyramids_gis-0.57.0.tar.gz
Upload date: Aug 26, 2026
Size: 1.0 MB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for pyramids_gis-0.57.0.tar.gz
Algorithm	Hash digest
SHA256	`30ce6da659704b600342201bba1f6b7193b80e410e65d318af85bdf399c288f0`
MD5	`bb9a5c69b20b7da85ae1d58834c18a7f`
BLAKE2b-256	`c4ba1cd4fbfed48743ce5cc668a52fe5f4aa4f0049e68175665d215fc88f2834`

Algorithm	Hash digest
SHA256	`709f2dedc4d8edd754f69cf0735ef78a1313ba0caa0f2db0c6f295de768a1b58`
MD5	`88b5a8a17338174d2027c8588a816dc4`
BLAKE2b-256	`2d3ec1f5535d0c434554abfe213f10bfbed69f0c7d55b64c0b5b21285e2bc52a`

Algorithm	Hash digest
SHA256	`e781002061831a3121e8f327c6c96bb1e36eb4a671d972dbae735628458669e0`
MD5	`d46f36583e6a62a34886331f6cd768a9`
BLAKE2b-256	`8e669b7f0a6f8ae43a73f9e883a5c6c402f3bcfedba64df1a2ab6b4ae9f83169`

Algorithm	Hash digest
SHA256	`34797770c744f7ba4e3797c3c6c86d048c4187cb793a30c2106e711356d64267`
MD5	`dd7d2ef759561ef82bd06a4640c99eb9`
BLAKE2b-256	`57ee760866ac53cd0603ca38b3ebdcaffc7b8b026ea6e7a98a63b6793e367169`

Algorithm	Hash digest
SHA256	`4d13a0e01f1275f089ebf6dc1a00b9e481179830ae6a810eb03577dbeb17880a`
MD5	`93a6c5161820a61a252b700ed3f9ad98`
BLAKE2b-256	`f4d7d0ad63e7b662011f454cad8befc347765bf6e1ca36544f56e23f5d39d98c`

Algorithm	Hash digest
SHA256	`d732bbed6b6031a40c036dce56028034e2b8eb50126d3f6ea6c53959bf2406ea`
MD5	`0b731919d1a7c0179f40ebaaf93b35e1`
BLAKE2b-256	`ed3e53a1977b94d02ed9e6102b53ade6504cb277ad9d960f5e5e9a27e305499f`

Algorithm	Hash digest
SHA256	`4567dde0f5832dc17d98dfc64f3a892edd68871b57ed8faf8a3a3a4fc2f448f7`
MD5	`704dda580f47f210bcf14081cf046868`
BLAKE2b-256	`63d0ae25eab13ac36dde2c9d7317ea5984e76ebc9046f0b78218bf7d716b27c6`

Algorithm	Hash digest
SHA256	`6ff28cd8e17e1200c5b3742f64ef3264f5916d739c3a329dcba4c0f272720fb4`
MD5	`2b3df391f06210ee85d97554d0e12dda`
BLAKE2b-256	`e4a7ebeacad77f3900c3993c5fbeaad13a4375abf1fda742a4231b4899237ca4`

Algorithm	Hash digest
SHA256	`450093b0c59be4052732793ffa7c131b9e3753f640f43e14b9d5721da665b4d4`
MD5	`41e0eaae9d96586371f08b62b3d1d2a9`
BLAKE2b-256	`297dd41662e28317e7cd8c5a1b9d33edc4d463cdb106edcc5782e6a6d1c27156`

Algorithm	Hash digest
SHA256	`a470780d3c495786107198d87f7613f31fc0b03f7d80c2302d7296aacd874933`
MD5	`fa937b61e91e168c089cf9cf43bcbe3e`
BLAKE2b-256	`464ba167fb01c60c64ff5958274e78b8d6bfac83402c7c2d9cee2cf4b6d800a2`

Algorithm	Hash digest
SHA256	`d8cb2a49b9705f4f76d396c8539d2337ba7cde8a9f92cbd7c800d244c209b1d6`
MD5	`3394b4d048a9d7dadc295d1fc8a0f848`
BLAKE2b-256	`d6b8f37c1d5402d5fa62d68e94a5eb5e43c87258eb42f00bcb55ef5608e0b7ac`

Algorithm	Hash digest
SHA256	`863ca4a6b555817055791f637e4538915715b2b62540d8e6b9ed420d1aee75b1`
MD5	`b0dbc0df4c726e606770949b4b175456`
BLAKE2b-256	`eb944aeec398afd2edec45d36a9f353bd3babc17c83e5049736ac7c11c9f8bb1`

Algorithm	Hash digest
SHA256	`cd902fc64cd5dcb305d2985b8138e3417c9fd63fb56fc83ff27cf2cc0602ea9d`
MD5	`5fc54aaf91456f5e3d857e7d97430f9a`
BLAKE2b-256	`1276ecb416cb64d15e14e4500a90fc4147a41cc9a4c5e561c96e754cf547ba4d`

Algorithm	Hash digest
SHA256	`8dec1f843895a96bc0df817909fe65f87e7c75b4e8307df7c57c569af85d25a0`
MD5	`a58850076bef55fa11f9bb4e647fa9a1`
BLAKE2b-256	`8849667f1e90db3500c46f49434a6682f5cd5b380d6c3f0445035775dc02558f`

Algorithm	Hash digest
SHA256	`b45cf8281f81bcb650ba8cd1703ac0aa1a467903abf2955e312ca0b1d9d8c6f8`
MD5	`40e4c3fc099958ecd10ca843cc1ffd63`
BLAKE2b-256	`40af15ade39b32077fae4dfa3fb52c8da6a6b605a6d30c33418bca49144494ab`

Algorithm	Hash digest
SHA256	`124cc3eee94018c0bb92186f93b0f706a33b8cff465efbeccd5cb633a1b2e566`
MD5	`f36b5d0f1265f53f7804005726b5fbf8`
BLAKE2b-256	`d8da64c0bd40c347f7b4eaafd23826482275ca3f182395a56aab9ba238071730`

Algorithm	Hash digest
SHA256	`0f4e7b64cd06ed3762306083bcc309f5dacb1667fbbd9c41e2ae4c9ca60d88bd`
MD5	`5cba1baf7ed4d8d33944faac244485c6`
BLAKE2b-256	`999bd4bf07a1c803864f9094bef1b21507893b2429fbd9ef63f3b2fbee0c31bc`

Algorithm	Hash digest
SHA256	`53bfb0b9964fe456f5c4819e40f73a10ad627eea2848fcb39ad9c1f6f3e812a9`
MD5	`b83ea9af0c3068cd3858a7d2d941c991`
BLAKE2b-256	`26db519e012c52ecd81363ed862a8c932d41fafa95ad5af8a7257501dee219cc`

Algorithm	Hash digest
SHA256	`c5230101c482844989518db9c2ee87294e4d7b7892d8d8ea968fda9cd10ecb9a`
MD5	`cfe5c748042113262c82c9600e383914`
BLAKE2b-256	`31a33a967ecf503d7b5c166e011dc0b67be22a7f77035d282865206fb450c1e1`

Algorithm	Hash digest
SHA256	`49c716761039daf755dda81935561576a146f2c76ca00b65f155ff7ce5303cee`
MD5	`d54caad7f0add7e39694df1e96bbcc95`
BLAKE2b-256	`124a50c5fa9a0aed408bd57a6389c67a915aae1eee0250a61b18d4b00f71dbb5`

Algorithm	Hash digest
SHA256	`1a91d8d5c6afdc58c224b84709f8ca3f163221a0ec50986f9afe2695fa300261`
MD5	`51e1846fe78a51f30c70910cdd8ef1aa`
BLAKE2b-256	`8fcffe6e7627d01eb8540dfd223618f36fad3ea837fe61fe261ca3ac26bcd43e`

pyramids-gis 0.57.0

Current release info

conda-forge feedstock

pyramids - GIS utility package

Main Features

Installing pyramids

Install from GitHub (development)

pip

Linux + pixi: no glibc pin needed anymore

Optional extras

Quick start

Testing

Docker

Project links

Key dates

1 maintainer

Credits

License

Requires

Provides Extra

Tags

Classifiers

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

Algorithm	Hash digest
SHA256	`3c668f8daef84391aa7adda2237c13453a49e97cbfe082fa78927701d04c5e34`
MD5	`160ca4936db2a0bb5f393da573282b69`
BLAKE2b-256	`1ddce851da5cd6e5ee236598a45cd7d651d616a63964890405041f73750c1f04`

Algorithm	Hash digest
SHA256	`5e831073db7242429f11d781170253ecc0b5bd56f5e799b01f2df2583727baf3`
MD5	`5bd3188429327c3ece2314e0351ce576`
BLAKE2b-256	`dc09d864dc8eaa3ccbd8538546a12262ca31fdc9dd63c069d0097a1a9425cfe7`

Algorithm	Hash digest
SHA256	`8e7e970800a6af067601c0fb0a4a7235a4f253ef7f2d867366863c895f4aeb7b`
MD5	`52eb3284f1ee579b64aac477ff9c2f3e`
BLAKE2b-256	`2fd0fe867bd61b1c2ce55964bb7b6d528d01758c275175105a623c8d44604c23`