CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[0.11] - 2024-07-31

Fixed

• PR#385 Fixed bug when connectivities are described by non-masked arrays. @stephenworsley
• PR#387 Fixed incompatibilities with changes to iris API in v3.10.0. @stephenworsley

Added

• PR#276 Allow regridding for grids defined on coordinates without bounds for nearest neighbour and bilinear methods. @stephenworsley

[0.10] - 2024-05-31

Added

• PR#357 Added support for saving and loading of ESMFAreaWeighted, ESMFBilinear and ESMFNearest regridders. @stephenworsley
• PR#319 Added CITATION.cff. @bjlittle

Changed

• PR#361 Moved the code for running benchmarks to bm_runner.py in line with iris benchmarks. @stephenworsley
• PR#293 Enumerated method and normtype input. @ESadek-MO

Fixed

• PR#239 Ensured dtype is preserved by regridding. @stephenworsley
• PR#353 Fixed a bug which caused errors with ESMF versions 8.6 and higher. @stephenworsley
• PR#338 Fixed a potential memory leak when creating regridders. @stephenworsley

[0.9] - 2023-11-03

Added

• PR#178 Added support for coordinate systems with non-degree type units. @stephenworsley

• PR#311 Added support for Mesh to Mesh regridding. @HGWright

Fixed

• PR#301 Fixed a bug which caused errors when regridding with the node locations of a mesh whose face_node_connectivity had non-zero start_index. @stephenworsley

[0.8] - 2023-08-22

Added

• PR#289 Added the ability to regrid onto a Mesh as a target instead of a Cube. @stephenworsley

[0.7] - 2023-05-23

Added

• PR#198 As a result of refactoring regridders to all derive from the same class, _ESMFRegridder, functionality has been added to the ESMFAreaWeighted scheme and a new scheme, ESMFBilinear, has been added. These schemes are now able to handle both grids and meshes. Additionally, they are also able to specify the resolution of cells in these grids with the src_resolution and tgt_resolution keywords. @stephenworsley with extensive review work from @trexfeathers
• PR#266 Added Nearest neighbour regridding. @stephenworsley @HGWright
• PR#272 Add support for Python 3.11. @stephenworsley

Changed

• PR#198 Refactor regridders to all derive from the same class _ESMFRegridder. For the sake of consistency, the resolution keyword in GridToMeshESMFRegridder and MeshToGridESMFRegridder have been replaced by src_resolution and tgt_resolution respectively. @stephenworsley with extensive review work from @trexfeathers

Removed

• PR#272 Remove support for Python 3.8. @stephenworsley

Fixed

• PR#258 Allow the documentation to build properly. @zklaus

[0.6] - 2023-03-31

Added

• PR#217 Changed the behaviour of coordinate fetching to allow Cubes with both 1D DimCoords and 2D AuxCoords. In this case the DimCoords are prioritised. @stephenworsley
• PR#220 Matured the benchmarking architecture in line with the latest setup in SciTools/iris. @trexfeathers
• PR#241 Fixed compatibility with esmpy 8.4. @stephenworsley with help from @bjlittle and @valeriupredoi
• PR#219 Added support for 2D AuxCoords with discontiguities under masked values with the use_src_mask and use_tgt_mask keywords. @stephenworsleywith extensive review work from @trexfeathers

Fixed

• PR#242 Fixed an issue which caused regridding to curvilinear grids with lazy data to fail. @stephenworsley

[0.5] - 2022-10-14

This release improves the support for features such as Bilinear regridding, curvilinear grids and low resolution grids.

Added

• PR#148 Added support for Bilinear regridding for unstructured regridding.
• PR#165 Added RefinedGridInfo and resolution keyword for unstructured regridders.
• PR#166 Made weights array handling more robust for different formats of pre-computed weights matrices.
• PR#175 Add curvilinear support for unstructured regridders.
• PR#208 Unpin Python.

[0.4] - 2022-02-24

This release added the ability to regrid data stored on a UGRID mesh.

Added

• PR#31 PR#32 PR#36 PR#39 PR#46 PR#55 PR#96 Added the unstructured regridders GridToMeshESMFRegridder and MeshToGridESMFRegridder. @stephenworsley with extensive review work from @abooton and @jamesp with benchmarking help from @trexfeathers
• PR#130 PR#137 Added functions for saving of the unstructured regridders. @stephenworsley
• PR#155 Enabled Sphinx and RTD for automatically rendering the API. @trexfeathers

[0.3] - 2021-12-21

The major change with this version was the addition of the ability to regrid curvilinear grids (i.e. grids with 2D arrays of coordinates).

Added

• PR#125 Added support for curvilinear grids, i.e. cubes with 2D lat/lon coords. @stephenworsley
• PR#124 Improved generation of benchmark data to allow data to be generated from a common version/environment. @trexfeathers

[0.2] - 2021-08-25

The major change in this version is the addition of lazy regridding. This defers the calculation of regridding to the realisation of the data when the data is a dask array. Calculations may be parallelised via dask.

Added

• PR#80 Added support for lazy regridding, this showed an improvement in the performance of the regridding benchmarks. @stephenworsley
• PR#79 Added support for benchmarks on the CI. @trexfeathers
• PR#98 Added benchmarks for regridding with realised data. @stephenworsley
• PR#100 Added benchmarks for regridding with lazy data. @stephenworsley

Fixed

• PR#92 Fixed an issue with directory naming. @lbdreyer
• PR#83 Added missing docstrings. @stephenworsley