API Reference

• Calculation
  • Atmospheric Physics Functions
  • Statistical Functions
  • Emergent Constraint Functions
  • Legacy Functions (for backward compatibility)
  • Utility Functions
  • Example Usage
• Emergent Constraints
• Mann-Kendall
  • Key Features
  • Supported Test Families
  • Skyborn vs pymannkendall
  • Partial Mann-Kendall
  • Quick Start
  • Performance Optimization
  • API Reference
  • Statistical Background
  • Advantages
  • Use Cases
  • Best Practices
  • References
• Plotting
  • Plotting Utilities
  • Curly Vector Plots
  • Scatter Stippling
  • Example Usage
  • Visualization Examples
• Interpolation
  • Regridding Classes
  • Regridding Functions
  • Interpolation Functions
  • Curvilinear and Unstructured Interpolation
  • Example Usage
• GridFill
  • Overview
  • Standard Interface
  • xarray Interface
  • Examples
  • Performance Considerations
  • Mathematical Details
  • References
  • See Also
• Gradient
  • Spatial Gradients
  • Example Usage
• Causality
  • Overview
  • Key Features
  • Methods Available
  • Theoretical Background
  • Usage Examples
  • Significance Testing Methods
  • Interpretation Guidelines
  • Best Practices
  • Related Modules
  • References
• Spherical Harmonics (spharm)
  • Spharmt
  • SpheremackError
  • ValidationError
  • regrid()
  • gaussian_lats_wts()
  • getspecindx()
  • getgeodesicpts()
  • legendre()
  • specintrp()
  • ReducedGaussianSpharmt
  • Overview
  • Origins And Lineage
  • Key Features
  • Installation Requirements
  • Compared With Legacy pyspharm Packaging
  • Legacy Interface Notes
  • Quick Start
  • Classes
  • Functions
  • Unified Workflow Examples
  • Reduced-grid Workflow
  • ECTRANS Status
  • Data Conventions
  • Grid Types
  • Legendre Function Handling
  • Performance Considerations
  • Error Handling
  • Examples
  • Related Modules
  • References
• Windspharm
  • VectorWind
  • ReducedVectorWind
  • Overview
  • Interface Selection
  • Latitude Ordering
  • Main Features
  • Real-World Application Examples
  • Core Classes
  • Standard Interface
  • Xarray Interface
  • Tools and Utilities
  • xarray Interface
  • Examples
  • Error Handling
  • Performance Considerations
  • Mathematical Background
  • See Also

This section provides detailed API documentation for all Skyborn modules.

Calculation

Statistical analysis and emergent constraint methods.

Mann-Kendall

High-performance trend detection for climate data with vectorized implementations optimized for large multidimensional arrays.

Version 0.3.11 Highlights: - 15-30x performance improvements through vectorization - Climate data optimized (40×192×288 processed in ~30 seconds) - Memory efficient chunking (~25MB usage) - Enhanced Dask support for distributed computing

Plotting

Visualization and plotting utilities including NCL-like curly vectors and display-space-thinned scatter stippling for map and profile visualization.

Interpolation

Data interpolation and regridding.

GridFill

Advanced atmospheric data interpolation using Poisson equation solvers. Provides gap-filling and smoothing capabilities for irregular atmospheric datasets with physically-based methods.

Version 0.3.10 Highlights: - Enhanced xarray interface with automatic coordinate detection - Comprehensive tutorial and examples - Improved performance and convergence handling - Publication-ready visualization tools

Gradient

Spatial and temporal gradient calculations.

Causality

Causality analysis methods.

Spherical Harmonics Functions

Spherical harmonic transforms and spectral analysis for atmospheric and oceanic data.

Vector Wind Analysis Functions

Spherical harmonic vector wind analysis including vorticity, divergence, streamfunction, and velocity potential calculations.

Note

The ROF (Regularized Optimal Fingerprinting) module; currently under development and testing. Documentation will be available in future releases.

ROF

Reduced Order Form methods for climate model analysis.