.. the "raw" directive below is used to hide the title in favor of
just the logo being visible
.. raw:: html
.. |br| raw:: html
*********
Photutils
*********
.. raw:: html
.. only:: latex
.. image:: _static/photutils_banner.pdf
**Photutils** is an `affiliated package
`_ 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 `.
|br|
.. 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 `.
|br|
Getting Started
===============
.. toctree::
:maxdepth: 1
install.rst
whats_new/index.rst
overview.rst
pixel_conventions.rst
getting_started.rst
contributing.rst
citation.rst
license.rst
changelog
User Documentation
==================
Backgrounds
-----------
.. toctree::
:maxdepth: 1
background.rst
Source Detection
----------------
.. toctree::
:maxdepth: 1
detection.rst
segmentation.rst
Aperture Photometry
-------------------
.. toctree::
:maxdepth: 1
aperture.rst
PSF Photometry and Tools
------------------------
.. toctree::
:maxdepth: 1
psf.rst
epsf.rst
grouping.rst
psf_matching.rst
Source Measurements
-------------------
.. toctree::
:maxdepth: 1
segmentation.rst
centroids.rst
morphology.rst
Radial Profiles
---------------
.. toctree::
:maxdepth: 1
profiles.rst
Isophotes
---------
.. toctree::
:maxdepth: 1
isophote.rst
Utilities
---------
.. toctree::
:maxdepth: 1
utils.rst
datasets.rst
geometry.rst
Developer Documentation
=======================
.. toctree::
:maxdepth: 1
dev/releasing.rst
.. toctree::
:hidden:
test_function.rst