Functions and Classes Reference ================================ .. rst-class:: functions-classes-page This page provides a comprehensive list of all functions and classes available in Skyborn, organized by module for easy navigation. .. contents:: Quick Navigation :local: :depth: 2 Core Calculations ----------------- Atmospheric Physics Functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.calc .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.calc.troposphere.core.trop_wmo` - WMO tropopause calculation for multi-dimensional data * - :func:`skyborn.calc.troposphere.core.trop_wmo_profile` - WMO tropopause calculation for single atmospheric profiles * - :func:`skyborn.calc.troposphere.xarray.trop_wmo` - Xarray interface for tropopause calculation with automatic pressure generation * - :func:`skyborn.calc.baroc_growth_rate` - Chemke-style baroclinic normal-mode growth-rate diagnostic with automatic WMO tropopause gridding * - :func:`skyborn.calc.barot_growth_rate` - Chemke-style barotropic normal-mode growth-rate diagnostic from a horizontal zonal-wind profile * - :func:`skyborn.calc.geostrophic.core.geostrophic_wind` - Geostrophic wind calculation from geopotential height (NumPy interface) * - :class:`skyborn.calc.geostrophic.core.GeostrophicWind` - Class-based interface for geostrophic wind calculations * - :func:`skyborn.calc.geostrophic.xarray.geostrophic_wind` - Xarray interface for geostrophic winds with automatic coordinate detection * - :class:`skyborn.calc.geostrophic.xarray.GeostrophicWind` - Xarray-based class interface for geostrophic wind analysis * - :func:`skyborn.calc.GPI.core.potential_intensity` - Calculate tropical cyclone potential intensity (NumPy interface) * - :func:`skyborn.calc.GPI.xarray.potential_intensity` - Xarray interface for potential intensity with automatic unit conversion Statistical Functions ~~~~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.calc .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.calc.linear_regression` - Linear regression analysis * - :func:`skyborn.calc.spatial_correlation` - Spatial correlation analysis between gridded data and time series * - :func:`skyborn.calc.pearson_correlation` - Pearson correlation coefficient * - :func:`skyborn.calc.spearman_correlation` - Spearman rank correlation * - :func:`skyborn.calc.kendall_correlation` - Kendall's tau correlation * - :func:`skyborn.calc.calculate_potential_temperature` - Potential temperature calculation * - :func:`skyborn.calc.convert_longitude_range` - Longitude coordinate conversion Emergent Constraints ~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.calc.gaussian_pdf` - Gaussian probability density function * - :func:`skyborn.calc.emergent_constraint_posterior` - Posterior probability calculation * - :func:`skyborn.calc.emergent_constraint_prior` - Prior probability calculation * - :func:`skyborn.calc.calc_GAUSSIAN_PDF` - Gaussian PDF calculation * - :func:`skyborn.calc.calc_PDF_EC` - Emergent constraint PDF * - :func:`skyborn.calc.find_std_from_PDF` - Standard deviation from PDF * - :func:`skyborn.calc.calc_PDF_EC_PRIOR` - Prior PDF for emergent constraints Trend Analysis ~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.calc.mann_kendall_test` - Mann-Kendall trend test * - :func:`skyborn.calc.mann_kendall_multidim` - Multidimensional trend analysis * - :func:`skyborn.calc.mann_kendall_xarray` - Xarray Mann-Kendall implementation * - :func:`skyborn.calc.trend_analysis` - Comprehensive trend analysis GridFill - Atmospheric Data Interpolation ------------------------------------------ Core GridFill Functions ~~~~~~~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.gridfill .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.gridfill.fill` - Fill missing data using Poisson grid filling Xarray GridFill Interface ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.gridfill.xarray.fill` - Xarray interface for data filling * - :func:`skyborn.gridfill.xarray.fill_multiple` - Fill multiple variables * - :func:`skyborn.gridfill.xarray.validate_grid_coverage` - Validate grid coverage Interpolation and Regridding ----------------------------- Regridding Classes ~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.interp .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Class - Description * - :class:`skyborn.interp.Grid` - Grid definition class * - :class:`skyborn.interp.Regridder` - Base regridding class * - :class:`skyborn.interp.NearestRegridder` - Nearest neighbor regridding * - :class:`skyborn.interp.BilinearRegridder` - Bilinear interpolation regridding * - :class:`skyborn.interp.ConservativeRegridder` - Conservative regridding Interpolation Functions ~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.interp.interp_pressure_1d` - One-dimensional pressure-coordinate interpolation with linear and log-pressure modes * - :func:`skyborn.interp.interp_hybrid_to_pressure` - Hybrid to pressure interpolation * - :func:`skyborn.interp.pressure_at_hybrid_levels` - Diagnose pressure on hybrid model levels * - :func:`skyborn.interp.delta_pressure_hybrid` - Diagnose layer thickness between hybrid model levels * - :func:`skyborn.interp.interp_sigma_to_hybrid` - Sigma to hybrid interpolation * - :func:`skyborn.interp.interp_multidim` - Multidimensional interpolation * - :func:`skyborn.interp.nearest_neighbor_indices` - Find nearest neighbor indices * - :func:`skyborn.interp.regrid_dataset` - Regrid entire dataset * - :func:`skyborn.interp.rcm2points` - Curvilinear grid to scattered points (nearest neighbor) * - :func:`skyborn.interp.rcm2rgrid` - Curvilinear grid to rectilinear lat/lon grid regridding * - :func:`skyborn.interp.rgrid2rcm` - Rectilinear lat/lon grid to curvilinear grid regridding * - :func:`skyborn.interp.grid_to_triple` - Convert a 2D rectilinear grid to unstructured triples (x, y, value) * - :func:`skyborn.interp.triple_to_grid` - Place unstructured triples onto a rectilinear grid (nearest neighbor) Spatial Gradients ----------------- Gradient Functions ~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.gradients .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.gradients.calculate_gradient` - Calculate spatial gradients * - :func:`skyborn.gradients.calculate_meridional_gradient` - Meridional gradient calculation * - :func:`skyborn.gradients.calculate_zonal_gradient` - Zonal gradient calculation * - :func:`skyborn.gradients.calculate_vertical_gradient` - Vertical gradient calculation Plotting and Visualization --------------------------- Core Plotting Functions ~~~~~~~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.plot .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.plot.add_equal_axes` - Add a new Axes with equal height or width next to the original Axes * - :func:`skyborn.plot.createFigure` - Create a figure with specified size and DPI Specialized Plotting ~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.plot.curly_vector` - Plot NCL-like curly vectors from either NumPy-style x/y/u/v arrays or xarray datasets * - :func:`skyborn.plot.curly_vector_key` - Add an NCL-like reference-vector annotation matched to curly-vector scaling * - :func:`skyborn.plot.scatter` - Plot Matplotlib-compatible scatter points with optional NCL-style display-space thinning for gridded stippling masks Causality Analysis ------------------ Causality Functions ~~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.causality .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.causality.granger_causality` - Granger causality analysis * - :func:`skyborn.causality.liang_causality` - Liang information flow analysis Spherical Harmonics ------------------- Spherical Harmonics Functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.spharm .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :class:`skyborn.spharm.Spharmt` - Main class for spherical harmonic transforms with grid-spectral conversions * - :class:`skyborn.spharm.ReducedGaussianSpharmt` - Experimental packed reduced-Gaussian spherical harmonic transform interface * - :func:`skyborn.spharm.gaussian_lats_wts` - Compute gaussian latitudes (in degrees) and quadrature weights for spherical grids * - :func:`skyborn.spharm.regrid` - Spectral re-gridding with optional smoothing and/or truncation for data interpolation * - :func:`skyborn.spharm.getspecindx` - Compute indices of zonal wavenumber and degree for complex spherical harmonic coefficients * - :func:`skyborn.spharm.getgeodesicpts` - Compute points on sphere surface corresponding to icosahedral geodesic * - :func:`skyborn.spharm.legendre` - Compute associated Legendre functions for spherical harmonic calculations * - :func:`skyborn.spharm.specintrp` - Spectral interpolation to arbitrary point on sphere given harmonic coefficients Windspharm Analysis ------------------- Standard Interface ~~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.windspharm.standard .. note:: The following table provides quick reference to windspharm methods. For detailed documentation and proper linking, see the :doc:`api/windspharm` page. .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Class/Method - Description * - :class:`skyborn.windspharm.standard.VectorWind` - Standard vector wind analysis interface * - :meth:`skyborn.windspharm.standard.VectorWind.magnitude` - Wind magnitude computation * - :meth:`skyborn.windspharm.standard.VectorWind.vorticity` - Relative vorticity calculation * - :meth:`skyborn.windspharm.standard.VectorWind.divergence` - Horizontal divergence calculation * - :meth:`skyborn.windspharm.standard.VectorWind.vrtdiv` - Combined vorticity and divergence * - :meth:`skyborn.windspharm.standard.VectorWind.planetaryvorticity` - Planetary vorticity (Coriolis parameter) * - :meth:`skyborn.windspharm.standard.VectorWind.absolutevorticity` - Absolute vorticity (relative + planetary) * - :meth:`skyborn.windspharm.standard.VectorWind.streamfunction` - Stream function calculation * - :meth:`skyborn.windspharm.standard.VectorWind.velocitypotential` - Velocity potential calculation * - :meth:`skyborn.windspharm.standard.VectorWind.sfvp` - Combined stream function and velocity potential * - :meth:`skyborn.windspharm.standard.VectorWind.helmholtz` - Helmholtz decomposition of wind field * - :meth:`skyborn.windspharm.standard.VectorWind.irrotationalcomponent` - Irrotational (divergent) wind component * - :meth:`skyborn.windspharm.standard.VectorWind.nondivergentcomponent` - Non-divergent (rotational) wind component * - :meth:`skyborn.windspharm.standard.VectorWind.gradient` - Gradient of scalar field * - :meth:`skyborn.windspharm.standard.VectorWind.truncate` - Spectral truncation of wind field * - :meth:`skyborn.windspharm.standard.VectorWind.rossbywavesource` - Rossby wave source calculation Xarray Interface ~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Class/Method - Description * - :class:`skyborn.windspharm.xarray.VectorWind` - Xarray-based vector wind analysis interface * - :meth:`skyborn.windspharm.xarray.VectorWind.magnitude` - Wind magnitude with xarray metadata preservation * - :meth:`skyborn.windspharm.xarray.VectorWind.vorticity` - Relative vorticity with CF-compliant attributes * - :meth:`skyborn.windspharm.xarray.VectorWind.divergence` - Horizontal divergence with coordinate preservation * - :meth:`skyborn.windspharm.xarray.VectorWind.vrtdiv` - Vorticity and divergence with metadata * - :meth:`skyborn.windspharm.xarray.VectorWind.planetaryvorticity` - Planetary vorticity with coordinate information * - :meth:`skyborn.windspharm.xarray.VectorWind.absolutevorticity` - Absolute vorticity with full metadata * - :meth:`skyborn.windspharm.xarray.VectorWind.streamfunction` - Stream function with CF attributes * - :meth:`skyborn.windspharm.xarray.VectorWind.velocitypotential` - Velocity potential with metadata preservation * - :meth:`skyborn.windspharm.xarray.VectorWind.sfvp` - Stream function and velocity potential * - :meth:`skyborn.windspharm.xarray.VectorWind.helmholtz` - Helmholtz decomposition with xarray * - :meth:`skyborn.windspharm.xarray.VectorWind.irrotationalcomponent` - Irrotational component with coordinates * - :meth:`skyborn.windspharm.xarray.VectorWind.nondivergentcomponent` - Non-divergent component with metadata * - :meth:`skyborn.windspharm.xarray.VectorWind.gradient` - Gradient computation with coordinate preservation * - :meth:`skyborn.windspharm.xarray.VectorWind.truncate` - Spectral truncation with xarray * - :meth:`skyborn.windspharm.xarray.VectorWind.rossbywavesource` - Rossby wave source with CF-compliant output * - :meth:`skyborn.windspharm.xarray.VectorWind.streamfunction` - Stream function with CF attributes * - :meth:`skyborn.windspharm.xarray.VectorWind.velocitypotential` - Velocity potential with metadata preservation * - :meth:`skyborn.windspharm.xarray.VectorWind.sfvp` - Stream function and velocity potential * - :meth:`skyborn.windspharm.xarray.VectorWind.helmholtz` - Helmholtz decomposition with xarray * - :meth:`skyborn.windspharm.xarray.VectorWind.irrotationalcomponent` - Irrotational component with coordinates * - :meth:`skyborn.windspharm.xarray.VectorWind.nondivergentcomponent` - Non-divergent component with metadata * - :meth:`skyborn.windspharm.xarray.VectorWind.gradient` - Gradient computation with coordinate preservation * - :meth:`skyborn.windspharm.xarray.VectorWind.truncate` - Spectral truncation with xarray * - :meth:`skyborn.windspharm.xarray.VectorWind.rossbywavesource` - Rossby wave source with CF-compliant output Utility Functions ~~~~~~~~~~~~~~~~~ .. currentmodule:: skyborn.windspharm.tools .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function - Description * - :func:`skyborn.windspharm.tools.prep_data` - Prepare data arrays for VectorWind input * - :func:`skyborn.windspharm.tools.recover_data` - Restore original data shape and dimension order * - :func:`skyborn.windspharm.tools.get_recovery` - Create recovery function for multiple arrays * - :func:`skyborn.windspharm.tools.reverse_latdim` - Reverse latitude dimension order * - :func:`skyborn.windspharm.tools.order_latdim` - Ensure north-to-south latitude ordering Documentation Structure Guide ----------------------------- Complete Page Reference ~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 40 60 :class: skyborn-function-table * - Page/Section - Content & Purpose * - **Main Documentation Pages** - * - :doc:`index` - Main documentation homepage * - :doc:`installation` - Installation instructions * - :doc:`quickstart` - Quick start guide * - :doc:`functions_classes` - This page - complete function reference * - :doc:`contributing` - Contribution guidelines * - :doc:`changelog` - Version history and changes * - **API Reference** - * - :doc:`api/index` - API documentation overview * - :doc:`api/calculations` - Statistical and calculation functions * - :doc:`api/mann_kendall` - Mann-Kendall trend analysis * - :doc:`api/causality` - Causality analysis methods * - :doc:`api/gridfill` - Grid interpolation functions * - :doc:`api/interpolation` - Regridding and interpolation * - :doc:`api/gradients` - Spatial gradient calculations * - :doc:`api/plotting` - Visualization functions * - :doc:`api/spharm` - Spherical harmonics analysis * - :doc:`api/windspharm` - Vector wind analysis * - **Tutorials & Examples** - * - :doc:`notebooks/index` - Jupyter notebook tutorials overview * - :doc:`notebooks/gridfill_tutorial` - GridFill interpolation tutorial * - :doc:`notebooks/mann_kendall_tutorial` - Trend analysis tutorial * - :doc:`notebooks/windspharm_tutorial` - Vector wind analysis tutorial * - :doc:`notebooks/ecs_emergent_constraints_analysis` - Emergent constraints tutorial * - **Module Documentation** - * - :doc:`modules/index` - Auto-generated module index * - :doc:`modules/skyborn` - Complete module structure Function Usage Categories ~~~~~~~~~~~~~~~~~~~~~~~~~ .. list-table:: :header-rows: 1 :widths: 30 70 :class: skyborn-function-table * - Function/Class - Usage Category & Description * - **Atmospheric Physics** - * - :func:`skyborn.calc.troposphere.core.trop_wmo` - Multi-dimensional WMO tropopause calculation * - :func:`skyborn.calc.troposphere.core.trop_wmo_profile` - Single profile tropopause identification * - :func:`skyborn.calc.troposphere.xarray.trop_wmo` - Xarray tropopause analysis with auto pressure generation * - **Statistical Analysis** - * - :func:`skyborn.calc.pearson_correlation` - Correlation analysis * - :func:`skyborn.calc.spearman_correlation` - Non-parametric correlation * - :func:`skyborn.calc.spatial_correlation` - Spatial correlation patterns * - :func:`skyborn.calc.linear_regression` - Regression analysis * - :func:`skyborn.calc.gaussian_pdf` - Probability distributions * - **Trend Analysis** - * - :func:`skyborn.calc.mann_kendall_test` - Single series trend detection * - :func:`skyborn.calc.mann_kendall_multidim` - Multidimensional trend analysis * - :func:`skyborn.calc.trend_analysis` - Comprehensive trend analysis * - **Data Processing** - * - :func:`skyborn.gridfill.fill` - Missing data interpolation * - :func:`skyborn.gridfill.xarray.fill` - Xarray data filling * - **Spatial Analysis** - * - :func:`skyborn.gradients.calculate_gradient` - Spatial derivatives * - :func:`skyborn.gradients.calculate_meridional_gradient` - Meridional gradients * - :func:`skyborn.gradients.calculate_zonal_gradient` - Zonal gradients * - **Causality Analysis** - * - :func:`skyborn.causality.liang_causality` - Information flow analysis * - :func:`skyborn.causality.granger_causality` - Granger causality testing * - **Vector Analysis** - * - :class:`skyborn.windspharm.standard.VectorWind` - Standard vector wind analysis * - :class:`skyborn.windspharm.xarray.VectorWind` - Xarray-based vector analysis * - **Emergent Constraints** - * - :func:`skyborn.calc.emergent_constraint_posterior` - Posterior distributions * - :func:`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.