.. SkyTropD documentation master file, created by
   sphinx-quickstart on Sun Aug 19 18:23:07 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

====================================
Welcome to SkyTropD's documentation!
====================================
 
SkyTropD is a community-maintained package for calculating metrics of tropical width as described in `Adam et al. (2018)`__. This package continues the Python implementation of the original MATLAB |registered| version.

.. |registered| unicode:: U+00AE .. registered trademark sign

__ https://www.geosci-model-dev-discuss.net/gmd-2018-124/

This documentation describes version 2.14.0.


Download and Install
----------------------
See the :doc:`install` page for all the details.

Documentation
----------------------
There is a step by step :doc:`tutorial` intended to introduce you to many
aspects of the code.

There is also a :doc:`reference` with full details.


About SkyTropD
-----------------------------------
The MATLAB |registered| version was originally developed by the `ISSI Tropical Width Diagnostics Intercomparison Project`__.

 __ http://www.issibern.ch/teams/twdip/


SkyTropD is maintained by Qianye Su.

The original Python implementation was translated by Alison Ming with help from Paul William Staten and the TropD team.

Last updated: 6 May 2026  

.. toctree::
    :hidden:
    
    install
    tutorial
    reference
    helper