=========
Photutils
=========

|PyPI Version| |Conda Version| |Conda Downloads| |Astropy|

|Travis Status| |CircleCI Status| |Coveralls Status| |Latest RTD Status| |LGTM Grade|

Photutils is an `Astropy`_ package for detection and photometry of
astronomical sources.

Please see the `online documentation
<https://photutils.readthedocs.io>`_ for `installation instructions
<https://photutils.readthedocs.io/en/stable/install.html>`_ and usage
information.


Citing Photutils
----------------

|Zenodo|

If you use Photutils for a project that leads to a publication,
whether directly or as a dependency of another package, please include
the following acknowledgment::

    This research made use of Photutils, an Astropy package for
    detection and photometry of astronomical sources (Bradley et al.
    20XX).

where (Bradley et al. 20XX) is a citation to the `Zenodo record
<https://doi.org/10.5281/zenodo.596036>`_ of the Photutils version
that was used.  We also encourage citations in the main text wherever
appropriate.  Please see the `CITATION <photutils/CITATION>`_ file for
details and an example BibTeX entry.


License
-------

Photutils is licensed under a 3-clause BSD license.  Please see the
`LICENSE <LICENSE.rst>`_ file for details.


.. |PyPI Version| image:: https://img.shields.io/pypi/v/photutils?label=pypi%20package
    :target: https://pypi.org/project/photutils/
    :alt: PyPI Latest Release

.. |Conda Version| image:: https://img.shields.io/conda/vn/astropy/photutils?label=conda%20package
    :target: https://anaconda.org/astropy/photutils
    :alt: Conda Latest Release

.. |Conda Downloads| image:: https://img.shields.io/conda/dn/astropy/photutils?label=conda%20downloads
    :target: https://anaconda.org/astropy/photutils
    :alt: Conda Downloads

.. |Astropy| image:: https://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
    :target: https://www.astropy.org/
    :alt: Powered by Astropy

.. |Zenodo| image:: https://zenodo.org/badge/2640766.svg
    :target: https://zenodo.org/badge/latestdoi/2640766
    :alt: Zenodo Latest DOI

.. |Travis Status| image:: https://img.shields.io/travis/astropy/photutils/master?label=Travis%20CI
    :target: https://travis-ci.org/astropy/photutils
    :alt: Travis CI Status

.. |Coveralls Status| image:: https://coveralls.io/repos/astropy/photutils/badge.svg?branch=master
    :target: https://coveralls.io/github/astropy/photutils
    :alt: Coveralls Status

.. |CircleCI Status| image:: https://img.shields.io/circleci/build/github/astropy/photutils/master?label=CircleCI
    :target: https://circleci.com/gh/astropy/photutils
    :alt: CircleCI Status

.. |Stable RTD Status| image:: https://readthedocs.org/projects/photutils/badge/?version=stable
    :target: https://photutils.readthedocs.io/en/stable/
    :alt: Stable Documentation Status

.. |Latest RTD Status| image:: https://readthedocs.org/projects/photutils/badge/?version=latest
    :target: https://photutils.readthedocs.io/en/latest/
    :alt: Latest Documentation Status

.. |LGTM Grade| image:: https://img.shields.io/lgtm/grade/python/g/astropy/photutils.svg?logo=lgtm&logoWidth=18
    :target: https://lgtm.com/projects/g/astropy/photutils/context:python
    :alt: LGTM Grade

.. _Astropy: https://www.astropy.org/
