.. _spike/citation:

Citation
========

If you use this package or the scripts in `the repository <https://github.com/avapolzin/spike>`_ in a publication, please reference `Polzin (2025) <https://doi.org/10.21105/joss.08200>`_. Users may also wish to add a footnote linking to `https://github.com/avapolzin/spike <https://github.com/avapolzin/spike>`_ and/or consider adding this software to your acknowledgments. 

``spike`` relies on many other pieces of software. Please also credit the following codes/papers (if the stated condition is met):

* if you use ``spike`` with HST data: ``drizzlepac`` (`Hoffmann et al. 2021 <https://ui.adsabs.harvard.edu/abs/2021AAS...23821602H/abstract>`_)
* if you use ``spike`` with JWST data: ``jwst`` (`Bushouse et al. 2024 <https://zenodo.org/records/7038885>`_)
* if you use ``spike`` with Roman data: ``romancal`` (`Roman calibration pipeline developers 2024 <https://github.com/spacetelescope/romancal>`_)
* if you use ``TinyTim`` model PSFs: ``TinyTim`` (`Krist et al. 2011 <https://ui.adsabs.harvard.edu/abs/2011SPIE.8127E..0JK/abstract>`_)
* if you use ``TinyTim`` model PSFs with the Gillis et al. modification: ``TinyTim`` (`Krist et al. 2011 <https://ui.adsabs.harvard.edu/abs/2011SPIE.8127E..0JK/abstract>`_) + `Gillis et al. (2020) <https://ui.adsabs.harvard.edu/abs/2020MNRAS.496.5017G/abstract>`_
* if you use ``STPSF`` (formerly ``WebbPSF``) model PSFs: ``STPSF`` `(Perrin et al. 2025) <https://github.com/spacetelescope/stpsf>`_, ``WebbPSF`` (Perrin et al. `2012 <https://ui.adsabs.harvard.edu/abs/2012SPIE.8442E..3DP/abstract>`_; `2014 <https://ui.adsabs.harvard.edu/abs/2014SPIE.9143E..3XP/abstract>`_; `2024 <https://github.com/spacetelescope/webbpsf>`_)
* if you use ``PSFEx`` to generate empirical PSFs: ``PSFEx`` (`Bertin 2011 <https://ui.adsabs.harvard.edu/abs/2011ASPC..442..435B/abstract>`_) and ``SExtractor`` (`Bertin & Arnauts 1996 <https://ui.adsabs.harvard.edu/abs/1996A%26AS..117..393B/abstract>`_)
* if you use ePSFs: ``photutils`` (`Bradley et al. 2024 <https://zenodo.org/records/13989456>`_) and `Anderson & King (2000) <https://ui.adsabs.harvard.edu/abs/2000PASP..112.1360A/abstract>`_/`Anderson (2016) <https://ui.adsabs.harvard.edu/abs/2016wfc..rept...12A/abstract>`_
* if you use STDPSFs: ``photutils`` (`Bradley et al. 2024 <https://zenodo.org/records/13989456>`_) and `Anderson (2016) <https://ui.adsabs.harvard.edu/abs/2016wfc..rept...12A/abstract>`_ + the relevant instrument paper -- MIRI (`Libralato et al. 2024 <https://ui.adsabs.harvard.edu/abs/2024PASP..136c4502L/abstract>`_); NIRISS (`Libralato et al. 2023 <https://ui.adsabs.harvard.edu/abs/2023ApJ...950..101L/abstract>`_) 
* if you use ACS/WFC Focus-Diverse ePSFs: ``acstools`` (`Lim et al. 2022 <https://zenodo.org/records/7406933>`_), `Bellini et al. (2018) <https://ui.adsabs.harvard.edu/abs/2018acs..rept....8B/abstract>`_, and `Anand et al. (2023) <https://ui.adsabs.harvard.edu/abs/2023acs..rept....6A/abstract>`_

Note that the BibTeX for most of these references is included in the ``spike`` `paper.bib <https://github.com/avapolzin/spike/blob/master/paper/paper.bib>`_.


See a (mostly) complete and up-to-date list of papers that cite ``spike`` `here <https://ui.adsabs.harvard.edu/search/q=citations(bibcode%3A2025JOSS...10.8200P)>`_.