.. Skyborn documentation master file

.. image:: _static/SkyBornLogo.svg
   :align: center
   :width: 600px
   :alt: Skyborn Logo

Skyborn is a comprehensive Python package for climate data analysis, featuring advanced statistical methods, emergent constraint techniques, and interpolation, plotting, and spectral analysis utilities.

.. toctree::
   :maxdepth: 2

   quickstart
   installation
   notebooks/index
   gallery
   api/index
   modules/index
   functions_classes
   changelog
   contributing


Features
--------

* **Emergent Constraint Methods**: Advanced statistical techniques for reducing uncertainty in climate projections
* **GridFill Interpolation**: Sophisticated atmospheric data gap-filling using Poisson equation solvers
* **Windspharm Analysis**: Comprehensive spherical harmonic vector wind field analysis
* **Statistical Analysis**: Comprehensive statistical and correlation functions
* **Gradient Calculations**: Spatial and temporal gradient analysis tools
* **Causality Analysis**: Granger and Liang causality methods
* **Visualization**: High-quality plotting and visualization capabilities

**New in Version 0.3.10**: Enhanced GridFill module with xarray interface, comprehensive documentation, and tutorial examples for atmospheric data interpolation.

Quick Start
-----------

Install Skyborn and start analyzing climate data:

.. code-block:: bash

   pip install skyborn

.. code-block:: python

   import skyborn as skb
   from skyborn.gridfill.xarray import gridfill_xarray

   # Use emergent constraint methods
   pdf = skb.gaussian_pdf(mu=0, sigma=1, x=x_values)

   # Advanced atmospheric data interpolation (NEW in v0.3.10)
   filled_data = gridfill_xarray(atmospheric_data, eps=1e-4)

   # Statistical analysis
   correlation = skb.pearson_correlation(x_data, y_data)

Reference Implementation
========================

Our emergent constraint methods are adapted from the work by blackcata:
https://github.com/blackcata/Emergent_Constraints/tree/master

Based on Cox, P. M., et al. (2013). Nature, 494(7437), 341-344.

Indices and tables
==================

* :doc:`functions_classes` - Complete list of functions and classes
* :ref:`genindex` - General index
* :ref:`modindex` - Module index
* :ref:`search` - Search documentation