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.

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

Uploaded Source

Built Distribution

xarray_regrid-0.2.2-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for xarray_regrid-0.2.2.tar.gz
Algorithm Hash digest
SHA256 ab47868dd2fa0de6fc520da1a633baaf2e60992c2f40300cd414a8903f41c371
MD5 dffaa29a40924e3c3fcac6bc3d12e13a
BLAKE2b-256 9206456b661b3367d09f91462be63c428d3620a4e26cebf18ef799b03fd572ea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for xarray_regrid-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f1b3727044a08f7269ff90711679e6c92f9aa3618fbcf1e5b55cefddad6b7fb4
MD5 44422f707fee9fc31814d2b60f1163cc
BLAKE2b-256 4728faac45f5054740155f83b51bd8bb8f064c948a02df3525d0486bc1ab591f

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