.. statmorph documentation master file, created by
   sphinx-quickstart on Tue Oct 17 15:22:32 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

statmorph
=========

.. ~ **statmorph** is a Python package for calculating non-parametric morphological
.. ~ diagnostics of galaxy images, including the Gini-:math:`M_{20}` statistics
.. ~ (Lotz et al. 2004), the CAS statistics (Conselice 2003), the MID statistics
.. ~ (Freeman et al. 2013), and the shape asymmetry index (Pawlik et al. 2016).
.. ~ The code also performs single-component Sérsic fits.

.. ~ .. raw:: html

.. ~     <object data="_static/banner.svg" type="image/svg+xml" width="500"></object>

**statmorph** is an
`affiliated package of Astropy <https://www.astropy.org/affiliated/index.html>`_
for calculating non-parametric morphological diagnostics of galaxy images
(e.g., Gini-:math:`M_{20}` and CAS statistics), as well as fitting 2D Sérsic profiles.

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   overview
   installation
   description
   notebooks/tutorial
   examples
   api

Citing
------

If you use this code for a scientific publication, please cite the following
article:

- `Rodriguez-Gomez et al. (2019) <https://ui.adsabs.harvard.edu/abs/2019MNRAS.483.4140R>`_


Indices and tables
------------------

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