/gcm-filters

Diffusion-based Spatial Filtering of Gridded Data

Primary LanguagePythonOtherNOASSERTION

GCM Filters

codecov pre-commit Tests Documentation Status Conda Version PyPI version status

GCM-Filters: Diffusion-based Spatial Filtering of Gridded Data

Description

GCM-Filters is a python package that performs spatial filtering analysis in a flexible and efficient way. The GCM-Filters algorithm applies a discrete Laplacian to smooth a field through an iterative process that resembles diffusion (Grooms et al., 2021). The package can be used for either gridded observational data or gridded data that is produced by General Circulation Models (GCMs) of ocean, weather, and climate. Such GCM data come on complex curvilinear grids, whose geometry is respected by the GCM-Filters Laplacians. Through integration with dask, GCM-Filters enables parallel, out-of-core filter analysis on both CPUs and GPUs.

Installation

GCM-Filters can be installed with pip:

pip install gcm_filters

or conda

conda install -c conda-forge gcm_filters

Getting Started

To learn how to use GCM-Filters for your data, visit the GCM-Filters documentation.

Get in touch

Report bugs, suggest features or view the source code on GitHub.

License and copyright

GCM-Filters is licensed under version 3 of the Gnu Lesser General Public License.

Development occurs on GitHub at https://github.com/ocean-eddy-cpt/gcm-filters.