Skip to main content

Regridding tools using xarray and flox.

Project description

xarray-regrid: Regridding utilities for xarray.

Logo

With xarray-regrid it is possible to regrid between two rectilinear grids. The following methods are supported:

  • Linear
  • Nearest-neighbor
  • Conservative
  • Cubic
  • "Most common value" (zonal statistics)

Note that "Most common value" is designed to regrid categorical data to a coarse resolution. For regridding categorical data to a finer resolution, please use "nearest-neighbor" regridder.

DOI

Installation

pip install xarray-regrid

Usage

The xarray-regrid routines are accessed using the "regrid" accessor on an xarray Dataset:

import xarray_regrid

ds = xr.open_dataset("input_data.nc")
ds_grid = xr.open_dataset("target_grid.nc")

ds.regrid.linear(ds_grid)

For examples, see the benchmark notebooks and the demo notebooks.

Benchmarks

The benchmark notebooks contain comparisons to more standard methods (CDO, xESMF).

To be able to run the notebooks, a conda environment is required (due to ESMF and CDO). You can install this environment using the environment.yml file in this repository. Micromamba is a lightweight version of the much faster "mamba" conda alternative.

micromamba create -n environment_name -f environment.yml

Acknowledgements

This package was developed under Netherlands eScience Center grant NLESC.OEC.2022.017.

Project details


Download files

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

Source Distribution

xarray_regrid-0.2.3.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

xarray_regrid-0.2.3-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file xarray_regrid-0.2.3.tar.gz.

File metadata

  • Download URL: xarray_regrid-0.2.3.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for xarray_regrid-0.2.3.tar.gz
Algorithm Hash digest
SHA256 0f8bc2381fdb8ffec2c937a79d003d1e3fdce87e1def7ef5a9693e24acd853d0
MD5 7a8261bd5e5607db19060cb60a75ed38
BLAKE2b-256 05201a7c8bf2b166e4e61c490a8fe047c2c343922d59c5374e2654b14b7f4ae0

See more details on using hashes here.

File details

Details for the file xarray_regrid-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for xarray_regrid-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8fc5496dc8ebeb3150e72b8cc0a94008d48492b11e1e4bdb8d64182bc1a8b2bc
MD5 bbb591c22d9efaebb7eef246469d3f02
BLAKE2b-256 37fdc5cb47a48e29788fc5d0febdf66ccd86556b8b1e78f8e996d4009c4f88e4

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