
.. the "raw" directive below is used to hide the title in favor of
   just the logo being visible
.. raw:: html

    <style media="screen" type="text/css">
      h1 {display:none;}
    </style>

*********
Photutils
*********

.. raw:: html

   <img src="_static/photutils_banner.svg" onerror="this.src='_static/photutils_banner-475x120.png'; this.onerror=null;" width="495"/>

.. only:: latex

    .. image:: _static/photutils_banner.pdf


**Photutils** is an  `affiliated package
<https://www.astropy.org/affiliated/index.html>`_ of `Astropy`_ that
primarily provides tools for detecting and performing photometry of
astronomical sources.  It is an open source Python package and is
licensed under a :ref:`3-clause BSD license <photutils_license>`.

.. Important::
    If you use Photutils for a project that leads to a publication,
    whether directly or as a dependency of another package, please
    include an :doc:`acknowledgment and/or citation <citation>`.


Getting Started
===============

.. toctree::
    :maxdepth: 1

    install.rst
    overview.rst
    pixel_conventions.rst
    getting_started.rst
    contributing.rst
    citation.rst
    license.rst
    changelog


User Documentation
==================

.. toctree::
    :maxdepth: 1

    background.rst
    detection.rst
    grouping.rst
    aperture.rst
    psf.rst
    epsf.rst
    psf_matching.rst
    segmentation.rst
    centroids.rst
    morphology.rst
    isophote.rst
    geometry.rst
    datasets.rst
    utils.rst

.. toctree::
    :hidden:

    test_function.rst

.. note::

    Like much astronomy software, Photutils is an evolving package.
    The developers make an effort to maintain backwards compatibility,
    but at times the API may change if there is a benefit to doing so.
    If there are specific areas you think API stability is important,
    please let us know as part of the development process!
