.. meta::
    :keywords: petrofit, sersic fitting, python sersic fitting, sersic profile, petrosian, petrosian radius, galaxy sizes, astropy, photutils, python
    :google-site-verification: cGJeqxHDRwD274HDKyUfULiLjCZ5-UTJZK5h_TNMjPg

######################
PetroFit Documentation
######################

|github tag| |rtd tag| |astropy tag| |photutils tag|

PetroFit is a Python package designed for calculating Petrosian properties, such as radii and concentration indices,
as well as fitting galaxy light profiles. In particular, PetroFit includes tools for performing accurate photometry,
segmentations, Petrosian profiling, and Sérsic fitting. This documentation is intended to serve as a description and
guide to the `petrofit` Python module. See the  `Table of Contents <Table of Contents_>`_ below or use the sidebar to
navigate this documentation.

.. image:: ./images/cd_galaxy_demo.png
    :width: 100%
    :align: center

|

Table of Contents
=================
    
.. toctree::
    :caption: Getting Started
    :maxdepth: 2

    installation
    introduction
    citing

.. toctree::
    :caption: Fundamentals
    :maxdepth: 2

    quick_start
    photometry
    petrosian
    correction_grids
    fitting

.. toctree::
    :caption: Tutorials
    :maxdepth: 1

    fitting_workflow
    multi_object

.. toctree::
    :caption: Developer
    :maxdepth: 1

    api_reference
    release_procedure

.. |rtd tag| image:: https://readthedocs.org/projects/petrofit/badge/?version=latest
    :target: https://readthedocs.org/projects/petrofit/builds/
    :alt: Documentation Status

.. |github tag| image:: https://img.shields.io/badge/GitHub-black.svg?style=flat&logo=github
    :target: https://github.com/PetroFit/petrofit
    :alt: PetroFit GitHub

.. |astropy tag| image:: http://img.shields.io/badge/powered%20by-Astropy-orange.svg?style=flat&colorB=D93F0B
    :target: https://pypi.org/project/astropy
    :alt: Powered by Astropy

.. |photutils tag| image:: http://img.shields.io/badge/powered%20by-Photutils-blue.svg?style=flat&colorB=084680
    :target: https://pypi.org/project/photutils/
    :alt: Powered by Photutils