Skyborn Modules

Skyborn Modules#

This section provides an overview of all Skyborn modules and their functionality.

Core Modules#

The Skyborn package contains the following main modules:

  • calc: Statistical calculations and emergent constraint methods

  • gridfill: Advanced data interpolation using Poisson equation solvers

  • interp: Interpolation and regridding functions

  • plot: Specialized plotting and visualization tools

  • gradients: Spatial and temporal gradient calculations

  • causality: Causal analysis methods (Granger, Liang)

  • spharm: Spherical harmonic transforms and analysis (New in v0.3.8+)

  • windspharm: Vector wind field analysis on the sphere (New in v0.3.8+)

  • ROF: Regularized Optimal Fingerprinting (ROF) method; currently under development and testing.

Module Overview#

calc

Statistical calculations and emergent constraint methods for climate data analysis, including WMO tropopause diagnostics, geostrophic wind tools, and Chemke-style baroclinic/barotropic growth-rate diagnostics

gridfill (New in v0.3.10)

Advanced data interpolation using Poisson equation solvers for filling missing values in gridded data. Provides multiple interfaces (standard, iris, xarray) and algorithms for atmospheric and oceanic applications.

interp

Interpolation and regridding functions with improved dimension handling

plot

Specialized atmospheric data visualization with NCL-like curly vectors and display-space-thinned scatter stippling for maps and vertical profiles.

gradients

Spatial and temporal gradient calculations for atmospheric fields

causality

Granger and Liang causality analysis for climate variable relationships

spharm (New in v0.3.8+)

Spherical harmonic transforms and analysis for global atmospheric data. Provides fast spectral transforms, filtering, and grid conversions.

windspharm (New in v0.3.8+)

Comprehensive vector wind field analysis on the sphere including:

  • Vorticity and divergence calculations

  • Stream function and velocity potential computations

  • Helmholtz decomposition (rotational/irrotational components)

  • Spectral truncation and filtering

  • Multiple interface support (xarray, standard, tools)

ROF

Regularized Optimal Fingerprinting (ROF) method; currently under development and testing.

Getting Started#

To use any module, import Skyborn and access the module:

import skyborn as skb

# Use calculation functions
pdf = skb.calc.gaussian_pdf(mu=0, sigma=1, x=x_values)

# Growth-rate diagnostics
sigma_baroc = skb.calc.baroc_growth_rate(
    u_profile, temperature_profile, pressure_profile, lat=45.0, solver_levels=45
)
sigma_barot = skb.calc.barot_growth_rate(u_barotropic_profile, latitudes)

# Fill missing data with GridFill
from skyborn.gridfill.xarray import fill
filled_data = fill(data_with_gaps, eps=1e-4)

# Create visualizations
fig, ax = skb.plot.createFigure((10, 6), 1, 1)
stipple = skb.plot.scatter(ax, lon, lat, where=p_values < 0.05, density=2)

# NEW: Use spherical harmonic analysis
from skyborn.spharm import Spharmt
spharm = Spharmt(nlon=144, nlat=72, gridtype='gaussian')

# NEW: Analyze wind fields
from skyborn.windspharm.xarray import VectorWind
vw = VectorWind(u_wind, v_wind)
vorticity = vw.vorticity()
divergence = vw.divergence()

Version Highlights

  • v0.3.7: Enhanced documentation with interactive particle effects entrance page

  • v0.3.8: Added comprehensive windspharm module and improved spherical harmonics support

  • v0.3.9: Current version with optimized build system and enhanced cross-platform compatibility

  • v0.3.10: Major GridFill module expansion with advanced interpolation capabilities and comprehensive tutorial

For detailed API documentation, see API Reference.

Quick Links