search

astropy / photutils

Astropy package for source detection and photometry. Maintainer: @larrybradley
https://photutils.readthedocs.io
BSD 3-Clause "New" or "Revised" License
250 stars 138 forks source link
astronomy astropy astropy-affiliated photometry python source-detection

readme

========= Photutils

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

|CI Status| |Codecov Status| |Latest RTD Status|

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.
<YEAR>).

where (Bradley et al. ) 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 <https://github.com/astropy/photutils/blob/main/photutils/CITATION.rst> file for details and an example BibTeX entry.

License

Photutils is licensed under a 3-clause BSD license. Please see the LICENSE <https://github.com/astropy/photutils/blob/main/LICENSE.rst>_ file for details.

.. |PyPI Version| image:: https://img.shields.io/pypi/v/photutils.svg?logo=pypi&logoColor=white&label=PyPI :target: https://pypi.org/project/photutils/ :alt: PyPI Latest Release

.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/photutils :target: https://anaconda.org/conda-forge/photutils :alt: Conda Latest Release

.. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/photutils?label=PyPI%20Downloads :target: https://pypistats.org/packages/photutils :alt: PyPI 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/doi/10.5281/zenodo.596036 :alt: Zenodo Latest DOI

.. |CI Status| image:: https://github.com/astropy/photutils/workflows/CI%20Tests/badge.svg# :target: https://github.com/astropy/photutils/actions :alt: CI Status

.. |Codecov Status| image:: https://img.shields.io/codecov/c/github/astropy/photutils?logo=codecov :target: https://codecov.io/gh/astropy/photutils :alt: Coverage Status

.. |Stable RTD Status| image:: https://img.shields.io/readthedocs/photutils/latest.svg?logo=read%20the%20docs&logoColor=white&label=Docs&version=stable :target: https://photutils.readthedocs.io/en/stable/ :alt: Stable Documentation Status

.. |Latest RTD Status| image:: https://img.shields.io/readthedocs/photutils/latest.svg?logo=read%20the%20docs&logoColor=white&label=Docs&version=latest :target: https://photutils.readthedocs.io/en/latest/ :alt: Latest Documentation Status

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