Functions and Classes Reference#

This page provides a comprehensive list of all functions and classes available in Skyborn, organized by module for easy navigation.

Core Calculations #

Atmospheric Physics Functions #

Function	Description
`skyborn.calc.troposphere.core.trop_wmo()`	WMO tropopause calculation for multi-dimensional data
`skyborn.calc.troposphere.core.trop_wmo_profile()`	WMO tropopause calculation for single atmospheric profiles
`skyborn.calc.troposphere.xarray.trop_wmo()`	Xarray interface for tropopause calculation with automatic pressure generation
`skyborn.calc.baroc_growth_rate()`	Chemke-style baroclinic normal-mode growth-rate diagnostic with automatic WMO tropopause gridding
`skyborn.calc.barot_growth_rate()`	Chemke-style barotropic normal-mode growth-rate diagnostic from a horizontal zonal-wind profile
`skyborn.calc.geostrophic.core.geostrophic_wind()`	Geostrophic wind calculation from geopotential height (NumPy interface)
`skyborn.calc.geostrophic.core.GeostrophicWind`	Class-based interface for geostrophic wind calculations
`skyborn.calc.geostrophic.xarray.geostrophic_wind()`	Xarray interface for geostrophic winds with automatic coordinate detection
`skyborn.calc.geostrophic.xarray.GeostrophicWind`	Xarray-based class interface for geostrophic wind analysis
`skyborn.calc.GPI.core.potential_intensity()`	Calculate tropical cyclone potential intensity (NumPy interface)
`skyborn.calc.GPI.xarray.potential_intensity()`	Xarray interface for potential intensity with automatic unit conversion

Statistical Functions #

Function	Description
`skyborn.calc.linear_regression()`	Linear regression analysis
`skyborn.calc.spatial_correlation()`	Spatial correlation analysis between gridded data and time series
`skyborn.calc.pearson_correlation()`	Pearson correlation coefficient
`skyborn.calc.spearman_correlation()`	Spearman rank correlation
`skyborn.calc.kendall_correlation()`	Kendall’s tau correlation
`skyborn.calc.calculate_potential_temperature()`	Potential temperature calculation
`skyborn.calc.convert_longitude_range()`	Longitude coordinate conversion

Emergent Constraints #

Function	Description
`skyborn.calc.gaussian_pdf()`	Gaussian probability density function
`skyborn.calc.emergent_constraint_posterior()`	Posterior probability calculation
`skyborn.calc.emergent_constraint_prior()`	Prior probability calculation
`skyborn.calc.calc_GAUSSIAN_PDF()`	Gaussian PDF calculation
`skyborn.calc.calc_PDF_EC()`	Emergent constraint PDF
`skyborn.calc.find_std_from_PDF()`	Standard deviation from PDF
`skyborn.calc.calc_PDF_EC_PRIOR()`	Prior PDF for emergent constraints

Trend Analysis #

Function	Description
`skyborn.calc.mann_kendall_test()`	Mann-Kendall trend test
`skyborn.calc.mann_kendall_multidim()`	Multidimensional trend analysis
`skyborn.calc.mann_kendall_xarray()`	Xarray Mann-Kendall implementation
`skyborn.calc.trend_analysis()`	Comprehensive trend analysis

GridFill - Atmospheric Data Interpolation #

Core GridFill Functions #

Function	Description
`skyborn.gridfill.fill()`	Fill missing data using Poisson grid filling

Xarray GridFill Interface #

Function	Description
`skyborn.gridfill.xarray.fill()`	Xarray interface for data filling
`skyborn.gridfill.xarray.fill_multiple()`	Fill multiple variables
`skyborn.gridfill.xarray.validate_grid_coverage()`	Validate grid coverage

Interpolation and Regridding #

Regridding Classes #

Class	Description
`skyborn.interp.Grid`	Grid definition class
`skyborn.interp.Regridder`	Base regridding class
`skyborn.interp.NearestRegridder`	Nearest neighbor regridding
`skyborn.interp.BilinearRegridder`	Bilinear interpolation regridding
`skyborn.interp.ConservativeRegridder`	Conservative regridding

Interpolation Functions #

Function	Description
`skyborn.interp.interp_pressure_1d()`	One-dimensional pressure-coordinate interpolation with linear and log-pressure modes
`skyborn.interp.interp_hybrid_to_pressure()`	Hybrid to pressure interpolation
`skyborn.interp.pressure_at_hybrid_levels()`	Diagnose pressure on hybrid model levels
`skyborn.interp.delta_pressure_hybrid()`	Diagnose layer thickness between hybrid model levels
`skyborn.interp.interp_sigma_to_hybrid()`	Sigma to hybrid interpolation
`skyborn.interp.interp_multidim()`	Multidimensional interpolation
`skyborn.interp.nearest_neighbor_indices()`	Find nearest neighbor indices
`skyborn.interp.regrid_dataset()`	Regrid entire dataset
`skyborn.interp.rcm2points()`	Curvilinear grid to scattered points (nearest neighbor)
`skyborn.interp.rcm2rgrid()`	Curvilinear grid to rectilinear lat/lon grid regridding
`skyborn.interp.rgrid2rcm()`	Rectilinear lat/lon grid to curvilinear grid regridding
`skyborn.interp.grid_to_triple()`	Convert a 2D rectilinear grid to unstructured triples (x, y, value)
`skyborn.interp.triple_to_grid()`	Place unstructured triples onto a rectilinear grid (nearest neighbor)

Spatial Gradients #

Gradient Functions #

Function	Description
`skyborn.gradients.calculate_gradient()`	Calculate spatial gradients
`skyborn.gradients.calculate_meridional_gradient()`	Meridional gradient calculation
`skyborn.gradients.calculate_zonal_gradient()`	Zonal gradient calculation
`skyborn.gradients.calculate_vertical_gradient()`	Vertical gradient calculation

Plotting and Visualization #

Core Plotting Functions #

Function	Description
`skyborn.plot.add_equal_axes()`	Add a new Axes with equal height or width next to the original Axes
`skyborn.plot.createFigure()`	Create a figure with specified size and DPI

Specialized Plotting #

Function	Description
`skyborn.plot.curly_vector()`	Plot NCL-like curly vectors from either NumPy-style x/y/u/v arrays or xarray datasets
`skyborn.plot.curly_vector_key()`	Add an NCL-like reference-vector annotation matched to curly-vector scaling
`skyborn.plot.scatter()`	Plot Matplotlib-compatible scatter points with optional NCL-style display-space thinning for gridded stippling masks

Causality Analysis #

Causality Functions #

Function	Description
`skyborn.causality.granger_causality()`	Granger causality analysis
`skyborn.causality.liang_causality()`	Liang information flow analysis

Spherical Harmonics #

Spherical Harmonics Functions #

Function	Description
`skyborn.spharm.Spharmt`	Main class for spherical harmonic transforms with grid-spectral conversions
`skyborn.spharm.ReducedGaussianSpharmt`	Experimental packed reduced-Gaussian spherical harmonic transform interface
`skyborn.spharm.gaussian_lats_wts()`	Compute gaussian latitudes (in degrees) and quadrature weights for spherical grids
`skyborn.spharm.regrid()`	Spectral re-gridding with optional smoothing and/or truncation for data interpolation
`skyborn.spharm.getspecindx()`	Compute indices of zonal wavenumber and degree for complex spherical harmonic coefficients
`skyborn.spharm.getgeodesicpts()`	Compute points on sphere surface corresponding to icosahedral geodesic
`skyborn.spharm.legendre()`	Compute associated Legendre functions for spherical harmonic calculations
`skyborn.spharm.specintrp()`	Spectral interpolation to arbitrary point on sphere given harmonic coefficients

Windspharm Analysis #

Standard Interface #

Note

The following table provides quick reference to windspharm methods. For detailed documentation and proper linking, see the Windspharm page.

Class/Method	Description
`skyborn.windspharm.standard.VectorWind`	Standard vector wind analysis interface
`skyborn.windspharm.standard.VectorWind.magnitude()`	Wind magnitude computation
`skyborn.windspharm.standard.VectorWind.vorticity()`	Relative vorticity calculation
`skyborn.windspharm.standard.VectorWind.divergence()`	Horizontal divergence calculation
`skyborn.windspharm.standard.VectorWind.vrtdiv()`	Combined vorticity and divergence
`skyborn.windspharm.standard.VectorWind.planetaryvorticity()`	Planetary vorticity (Coriolis parameter)
`skyborn.windspharm.standard.VectorWind.absolutevorticity()`	Absolute vorticity (relative + planetary)
`skyborn.windspharm.standard.VectorWind.streamfunction()`	Stream function calculation
`skyborn.windspharm.standard.VectorWind.velocitypotential()`	Velocity potential calculation
`skyborn.windspharm.standard.VectorWind.sfvp()`	Combined stream function and velocity potential
`skyborn.windspharm.standard.VectorWind.helmholtz()`	Helmholtz decomposition of wind field
`skyborn.windspharm.standard.VectorWind.irrotationalcomponent()`	Irrotational (divergent) wind component
`skyborn.windspharm.standard.VectorWind.nondivergentcomponent()`	Non-divergent (rotational) wind component
`skyborn.windspharm.standard.VectorWind.gradient()`	Gradient of scalar field
`skyborn.windspharm.standard.VectorWind.truncate()`	Spectral truncation of wind field
`skyborn.windspharm.standard.VectorWind.rossbywavesource()`	Rossby wave source calculation

Xarray Interface #

Class/Method	Description
`skyborn.windspharm.xarray.VectorWind`	Xarray-based vector wind analysis interface
`skyborn.windspharm.xarray.VectorWind.magnitude()`	Wind magnitude with xarray metadata preservation
`skyborn.windspharm.xarray.VectorWind.vorticity()`	Relative vorticity with CF-compliant attributes
`skyborn.windspharm.xarray.VectorWind.divergence()`	Horizontal divergence with coordinate preservation
`skyborn.windspharm.xarray.VectorWind.vrtdiv()`	Vorticity and divergence with metadata
`skyborn.windspharm.xarray.VectorWind.planetaryvorticity()`	Planetary vorticity with coordinate information
`skyborn.windspharm.xarray.VectorWind.absolutevorticity()`	Absolute vorticity with full metadata
`skyborn.windspharm.xarray.VectorWind.streamfunction()`	Stream function with CF attributes
`skyborn.windspharm.xarray.VectorWind.velocitypotential()`	Velocity potential with metadata preservation
`skyborn.windspharm.xarray.VectorWind.sfvp()`	Stream function and velocity potential
`skyborn.windspharm.xarray.VectorWind.helmholtz()`	Helmholtz decomposition with xarray
`skyborn.windspharm.xarray.VectorWind.irrotationalcomponent()`	Irrotational component with coordinates
`skyborn.windspharm.xarray.VectorWind.nondivergentcomponent()`	Non-divergent component with metadata
`skyborn.windspharm.xarray.VectorWind.gradient()`	Gradient computation with coordinate preservation
`skyborn.windspharm.xarray.VectorWind.truncate()`	Spectral truncation with xarray
`skyborn.windspharm.xarray.VectorWind.rossbywavesource()`	Rossby wave source with CF-compliant output
`skyborn.windspharm.xarray.VectorWind.streamfunction()`	Stream function with CF attributes
`skyborn.windspharm.xarray.VectorWind.velocitypotential()`	Velocity potential with metadata preservation
`skyborn.windspharm.xarray.VectorWind.sfvp()`	Stream function and velocity potential
`skyborn.windspharm.xarray.VectorWind.helmholtz()`	Helmholtz decomposition with xarray
`skyborn.windspharm.xarray.VectorWind.irrotationalcomponent()`	Irrotational component with coordinates
`skyborn.windspharm.xarray.VectorWind.nondivergentcomponent()`	Non-divergent component with metadata
`skyborn.windspharm.xarray.VectorWind.gradient()`	Gradient computation with coordinate preservation
`skyborn.windspharm.xarray.VectorWind.truncate()`	Spectral truncation with xarray
`skyborn.windspharm.xarray.VectorWind.rossbywavesource()`	Rossby wave source with CF-compliant output

Utility Functions #

Function	Description
`skyborn.windspharm.tools.prep_data()`	Prepare data arrays for VectorWind input
`skyborn.windspharm.tools.recover_data()`	Restore original data shape and dimension order
`skyborn.windspharm.tools.get_recovery()`	Create recovery function for multiple arrays
`skyborn.windspharm.tools.reverse_latdim()`	Reverse latitude dimension order
`skyborn.windspharm.tools.order_latdim()`	Ensure north-to-south latitude ordering

Documentation Structure Guide #

Complete Page Reference #

Page/Section	Content & Purpose
Main Documentation Pages
Features	Main documentation homepage
Installation	Installation instructions
Quick Start Guide	Quick start guide
Functions and Classes Reference	This page - complete function reference
Contributing	Contribution guidelines
Changelog	Version history and changes
API Reference
API Reference	API documentation overview
Calculation	Statistical and calculation functions
Mann-Kendall	Mann-Kendall trend analysis
Causality	Causality analysis methods
GridFill	Grid interpolation functions
Interpolation	Regridding and interpolation
Gradient	Spatial gradient calculations
Plotting	Visualization functions
Spherical Harmonics (spharm)	Spherical harmonics analysis
Windspharm	Vector wind analysis
Tutorials & Examples
Tutorials	Jupyter notebook tutorials overview
GridFill Tutorial: Advanced Data Interpolation	GridFill interpolation tutorial
Tutorial: Mann-Kendall Trend Analysis with Real GPCP Precipitation	Trend analysis tutorial
Windspharm Tutorial: Spherical Harmonic Wind Analysis	Vector wind analysis tutorial
Emergent Constraints Analysis	Emergent constraints tutorial
Module Documentation
Modules	Auto-generated module index
Skyborn Modules	Complete module structure

Function Usage Categories #

Function/Class	Usage Category & Description
Atmospheric Physics
`skyborn.calc.troposphere.core.trop_wmo()`	Multi-dimensional WMO tropopause calculation
`skyborn.calc.troposphere.core.trop_wmo_profile()`	Single profile tropopause identification
`skyborn.calc.troposphere.xarray.trop_wmo()`	Xarray tropopause analysis with auto pressure generation
Statistical Analysis
`skyborn.calc.pearson_correlation()`	Correlation analysis
`skyborn.calc.spearman_correlation()`	Non-parametric correlation
`skyborn.calc.spatial_correlation()`	Spatial correlation patterns
`skyborn.calc.linear_regression()`	Regression analysis
`skyborn.calc.gaussian_pdf()`	Probability distributions
Trend Analysis
`skyborn.calc.mann_kendall_test()`	Single series trend detection
`skyborn.calc.mann_kendall_multidim()`	Multidimensional trend analysis
`skyborn.calc.trend_analysis()`	Comprehensive trend analysis
Data Processing
`skyborn.gridfill.fill()`	Missing data interpolation
`skyborn.gridfill.xarray.fill()`	Xarray data filling
Spatial Analysis
`skyborn.gradients.calculate_gradient()`	Spatial derivatives
`skyborn.gradients.calculate_meridional_gradient()`	Meridional gradients
`skyborn.gradients.calculate_zonal_gradient()`	Zonal gradients
Causality Analysis
`skyborn.causality.liang_causality()`	Information flow analysis
`skyborn.causality.granger_causality()`	Granger causality testing
Vector Analysis
`skyborn.windspharm.standard.VectorWind`	Standard vector wind analysis
`skyborn.windspharm.xarray.VectorWind`	Xarray-based vector analysis
Emergent Constraints
`skyborn.calc.emergent_constraint_posterior()`	Posterior distributions
`skyborn.calc.emergent_constraint_prior()`	Prior distributions

Note

This page provides a comprehensive list of all functions and classes available in Skyborn. Each entry links to detailed API documentation with parameter descriptions, examples, and usage guidelines.

Tip

Quick Navigation: Use Ctrl+F (Cmd+F on Mac) to quickly search for specific functions or keywords within this page. You can also use the Quick Navigation menu above to jump to different sections.

Functions and Classes Reference

Contents

Functions and Classes Reference#