.. TurbuStat documentation master file, created by
   sphinx-quickstart on Mon Jun  8 14:54:35 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

TurbuStat
=========

TurbuStat provides a set of analysis tools for comparing astronomical radio datacubes, as well as column density, integrated intensity or cube moment maps. Each statistic returns a measure of "distance" between the two datasets.

The source code is hosted `here <https://github.com/Astroua/TurbuStat>`_. Contributions to the code base are very much welcome! If you find any issues in the package, please make an `issue on github <https://github.com/Astroua/TurbuStat/issues>`_ or contact the developers at the email on `this page <https://github.com/e-koch>`_. Thank you!

If you make use of this package in a publication, please cite our accompanying paper:
::
   @ARTICLE{Koch2016,
    author = {{Koch}, Eric~W. and {Ward}, Caleb~G. and {Offner}, Stella and {Loeppky}, Jason~L. and {Rosolowsky}, Erik~W.},
    title = {Tools for Critically Evaluating Simulations of Star Formation},
    journal = {MNRAS},
    year = {submitted}
    }

This package was developed by:

* `Eric Koch <https://github.com/e-koch>`_
* `Caleb Ward <https://github.com/Astrolebs>`_
* `Erik Rosolowsky <https://github.com/low-sky>`_
* `Jason Loeppky <https://github.com/jloeppky>`_

Contents:

.. toctree::
   :maxdepth: 2

   install.rst
   tutorials/index
   moments.rst
   cube_tools.rst
   statistics.rst
   helper_scripts.rst

Papers using TurbuStat
----------------------

* `Boyden et al. (2016) <http://adsabs.harvard.edu/abs/2016ApJ...833..233B>`_



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

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