API Reference
=============

.. toctree::
   :maxdepth: 2

   calculations
   mann_kendall
   plotting
   interpolation
   gridfill
   gradients
   causality
   spharm
   windspharm

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.