Overview
========

octant is a Python library used for post-processing the output of `PMCTRACK`_ - vorticity-based cyclone tracking algorithm.

.. _pmctrack: https://github.com/dennissergeev/pmctrack

Contents
--------
.. toctree::
   :maxdepth: 1
   :glob:

   install
   examples/index.rst
   api/index.rst
   changelog
   contributing


See also
--------

- Denis Sergeev's `thesis`_, in which Chapter 4 is based on octant output.
- The `pandas`_ and `xarray`_ packages, upon which octant relies heavily.

.. _thesis: https://ueaeprints.uea.ac.uk/68204/
.. _pandas:  https://pandas.pydata.org
.. _xarray:  https://xarray.pydata.org


License
-------
Octant is released under the terms of the MIT license.


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

* :ref:`genindex`
* :ref:`search`