Skip to main content

Regridding based on sparse matrix multiplication

Project description

Maintenance PyTest Coverage Status PyPI version

smmregrid

A compact regridder using sparse matrix multiplication

This repository represents a modification of the regridding routines in climtas by Scott Wales, which already implements efficiently this idea and has no other significant dependencies. The regridder uses efficiently sparse matrix multiplication with dask + some manipulation of the coordinates.

Please note that this tool is not thought as "another interpolation tool", but rather a method to apply pre-computed weights (with CDO, which is currently tested) within the python environment. The speedup is estimated to be about ~1.5 to ~5 times, slightly lower if then files are written to the disk. 2D and 3D data are supported on all the grids supported by CDO, both xarray.Dataset and xarray.DataArray can be used. Masks are treated in a simple way but are correctly transfered. Attributes are kept.

The tool works for python versions >=3.8. It is safer to run it through conda/mamba. Install with:

mamba env create -f environment.yml

then activate the environment:

mamba activate smmregrid

and install smmregrid in editable mode:

pip install -e .

Alternatively - if you have in your environment/machine the required dependencies, mostly CDO - you can install smmregrid directly via pypi with:

pip install smmregrid

Cautionary notes:

  • It does not work correctly if the Xarray.Dataset includes fields with time-varying missing points
  • It works only with interpolation methods/grids supported by CDO
  • It does not support ESMF weigths.

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

smmregrid-0.0.7.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

smmregrid-0.0.7-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file smmregrid-0.0.7.tar.gz.

File metadata

  • Download URL: smmregrid-0.0.7.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for smmregrid-0.0.7.tar.gz
Algorithm Hash digest
SHA256 d9fecd82c386d015dd960de73b9d8318629223c8f5dbcb010412d0407cc75ebd
MD5 9bf52c4b4506a112484522eb335e22a6
BLAKE2b-256 a48097bafc859589b8e672e847c40509971dc2d573b4ae5dd1e6cd5ad8b47fe7

See more details on using hashes here.

File details

Details for the file smmregrid-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: smmregrid-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for smmregrid-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1a7ef067c76bbb55f99e5b1cd33e414988c338c23c47fa9741f20ef008a4347d
MD5 bf97cd003a368ec6b0cd9a3df5a777c1
BLAKE2b-256 3ed7e3f380922ba58eb7087ad94ffc3e6caee39dc19a3f9d967536bff8e58dc3

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