XESMF.jl

A Julia package for sparse regridding weights using the xESMF Python library.

Overview

XESMF.jl provides a Julia interface to the xESMF (xarray Earth System Model Exchange Format) Python library, enabling efficient computation of sparse regridding weights for Earth system models. This package is particularly useful for working with Oceananigans.jl and other geophysical modeling packages.

Features

• Sparse Regridding Weights: Compute sparse matrices for efficient regridding between different grid types
• Python Integration: Seamless integration with the xESMF Python library via PythonCall.jl
• Oceananigans Compatible: Designed to work with Oceananigans.jl grids and fields
• Type Flexibility: Support for different numeric types (Float64, Float32, etc.)

Installation

using Pkg
Pkg.add("XESMF")

Quick Start

using Oceananigans
using XESMF

# Create grids
tg = TripolarGrid(size=(360, 170, 1), z=(0, 1))
ll = LatitudeLongitudeGrid(size=(360, 180, 1), longitude=(0, 360), latitude=(-90, 90), z=(0, 1))

# Create center fields
ctg = CenterField(tg)
cll = CenterField(ll)

# Compute regridding weights
# weights = sparse_regridding_weights(cll, ctg)

Dependencies

XESMF.jl depends on:

• CondaPkg.jl: For managing Python dependencies
• PythonCall.jl: For Python-Julia interoperability
• SparseArrays.jl: For sparse matrix operations

The package automatically installs the xESMF Python library via CondaPkg.

Integration with Oceananigans.jl

XESMF.jl is designed to work seamlessly with Oceananigans.jl for ocean modeling applications:

using Oceananigans
using XESMF

# Create grids
tg = TripolarGrid(size=(360, 170, 1), z=(0, 1))
ll = LatitudeLongitudeGrid(size=(360, 180, 1), longitude=(0, 360), latitude=(-90, 90), z=(0, 1))

# Create center fields
ctg = CenterField(tg)
cll = CenterField(ll)

# Compute regridding weights
# weights = sparse_regridding_weights(cll, ctg)

Documentation Structure

• API Reference: Complete function documentation
• Examples: Usage examples and tutorials
• Development: Contributing and development guidelines

License

This package is licensed under the same terms as the Julia language itself.

Contributing

Contributions are welcome! Please see the Development section for guidelines.