Skip to main content

Regridding based on sparse matrix multiplication

Project description

Maintenance PyTest Coverage Status PyPI version Documentation DOI

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.3.tar.gz (30.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.3-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for smmregrid-0.1.3.tar.gz
Algorithm Hash digest
SHA256 44837c85481f146f0a1f01ea8ebf633e908e40a8230d3d0c22d937d0cde1b718
MD5 aa6cb1c0c455cdf274c798bbe7ab1bdd
BLAKE2b-256 992b17d8518782a5c99cd18402bc577cc52a4d5f708813fd798b2e83b6ad8a26

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for smmregrid-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 74c254af9f6e6a93071f1e6eeb923aa8b8c77380ef800a1e89fc52c428387012
MD5 13d70b9cc54c2507c4f0cc31cd625246
BLAKE2b-256 a23e9e6612fee18466e82efefc9acecf69ca948450e294e014457487d42fc77a

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