Skip to main content

Regridding based on sparse matrix multiplication

Project description

Maintenance PyTest Coverage Status PyPI version Documentation

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

Uploaded Source

Built Distribution

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

smmregrid-0.1.1-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: smmregrid-0.1.1.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for smmregrid-0.1.1.tar.gz
Algorithm Hash digest
SHA256 57dba91d80448cacd684f078229dddcf86029f33cbaf287690abd4e1c1f039ef
MD5 e7871d80a2020a56be366cd3e948b554
BLAKE2b-256 07a62d9abe84f08219e961ef9085babc197465d748f08a22a4184ed7a602cf7a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: smmregrid-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 31.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for smmregrid-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bf2fdf7946d7b755f6825e1ea2e5d0799aa794217cd8612ff3adf19936b80f52
MD5 60dbefd7a90a655dee537c809b511fb4
BLAKE2b-256 90a877c9a0b96842ce7a141bc07bea85bb70df2456c038235f93de53f904d2db

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page