Nan threshold for conservative regridding (continuation of #39) (#41)

* add nan_threshold option

* track nan frac across dims, use xr.dot, consolidate ds/da paths, tests

* fixes and cleanup plus initial notebook cell

* speed up by only tracking the max of nonnull points over non_regrid_dims

* fix tests for newer dependency versions

* Improve typing of call_on_dataset

* Fix typing in updated conservative routines

* Apply code formatting

* Ensure hashable is a valid input for coordinate identifier

* Make tests & typing pass

* Make `create_regridding_dataset` a method of `Grid` #38

* Update notebooks and dependencies

* Allow xesmf test to run if it's available

* Add @slevang to the contributors list

* Update changelog

* Ignore linter in test

* Update readme with badges and "why use..." text

---------

Co-authored-by: Sam Levang <[email protected]>

Author: BSchilperoort

CHANGELOG.md

@@ -6,8 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## Unreleased
 
+New contributors:
+ - @slevang
+
+Fixed:
+ - conservative regridding now can be constructed fully lazily [#39](https://github.com/EXCITED-CO2/xarray-regrid/pull/39).
+
 Added:
- - Documentation for the package, including readthedocs integration ([#40](https://github.com/EXCITED-CO2/xarray-regrid/pull/40)).
+ - documentation for the package, including readthedocs integration ([#40](https://github.com/EXCITED-CO2/xarray-regrid/pull/40)).
+ - better handling of NaNs to the conservative regridding routine, with a `nan_threshold` keyword argument. For more information see the notebooks on the documentation [#39](https://github.com/EXCITED-CO2/xarray-regrid/pull/39) \& [#41](https://github.com/EXCITED-CO2/xarray-regrid/pull/41).
+ - `create_regridding_dataset` as a method of the `xarray_regrid.Grid` dataclass [#41](https://github.com/EXCITED-CO2/xarray-regrid/pull/41).
 
 ## v0.2.3 (2024-02-29)
 

CITATION.cff

@@ -18,16 +18,17 @@ authors:
     family-names: Doore
     orcid: 'https://orcid.org/0000-0001-5035-4016'
     affiliation: United States Geological Survey
-    
+  - given-names: Sam
+    family-names: Levang
+    affiliation: Salient Predictions
+
 repository-code: 'https://github.com/EXCITED-CO2/xarray-regrid'
 keywords:
   - xarray
   - geospatial
   - regridding
   - conservative regridding
 license: Apache-2.0
-version: 0.2.3
-date-released: '2023-11-24'
 abstract: >
   xarray-regrid can regrid (geospatial) data to a new
   coordinate system.

README.md

@@ -2,6 +2,7 @@
 
 <img align="right" width="100" alt="Logo" src="./docs/assets/logo.png">
 
+
 With xarray-regrid it is possible to regrid between two rectilinear grids. The following methods are supported:
  - Linear
  - Nearest-neighbor
@@ -11,7 +12,13 @@ With xarray-regrid it is possible to regrid between two rectilinear grids. The f
 
 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.
 
+[![PyPI](https://img.shields.io/pypi/v/xarray-regrid.svg?style=flat)](https://pypi.python.org/pypi/xarray-regrid/)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10203304.svg)](https://doi.org/10.5281/zenodo.10203304)
+[![Docs](https://readthedocs.org/projects/xarray-regrid/badge/?version=latest&style=flat)](https://xarray-regrid.readthedocs.org/)
+
+## Why xarray-regrid?
+
+Regridding is a common operation in earth science and other fields. While xarray does have some interpolation methods available, these are not always straightforward to use. Additionally, methods such as conservative regridding, or taking the most common value, are not available in xarray.
 
 ## Installation
 

docs/notebooks/benchmarks/benchmarking_bilinear.ipynb

@@ -19,3 +19,4 @@ Most notebooks compare the methods implemented in xarray-regrid against more sta
   :caption: Demos
 
   demos/demo_most_common.ipynb
+  demos/demo_conservative_nan_threshold.ipynb

docs/notebooks/benchmarks/benchmarking_conservative.ipynb

@@ -3,8 +3,11 @@ name: xarray-regrid
 channels:
   - conda-forge
 dependencies:
-  - python==3.10
+  - python==3.12
   - xESMF
   - cdo
   - pip:
-      - "xarray-regrid"
+      - "xarray-regrid"
+      - "cftime"
+      - "matplotlib"
+      - "dask[distributed]"