.. _citing_sunpy:

Acknowledging or Citing SunPy
=============================

If you use SunPy in your scientific work, we would appreciate citing it in your publications.
The continued growth and development of SunPy is dependent on the community being aware of SunPy.

Citing SunPy in Publications
----------------------------

Please add the following line within your methods, conclusion or acknowledgements sections:

   *This research used version X.Y.Z (software citation) of the SunPy open source
   software package (project citation).*

The project citation should be to the SunPy paper :cite:p:`the_sunpy_community_sunpy_2020`, and the software citation should be the specific `Zenodo DOI`_ for the version used in your work.

.. code:: bibtex

    @ARTICLE{sunpy_community2020,
      doi = {10.3847/1538-4357/ab4f7a},
      url = {https://iopscience.iop.org/article/10.3847/1538-4357/ab4f7a},
      author = {{The SunPy Community} and Barnes, Will T. and Bobra, Monica G. and Christe, Steven D. and Freij, Nabil and Hayes, Laura A. and Ireland, Jack and Mumford, Stuart and Perez-Suarez, David and Ryan, Daniel F. and Shih, Albert Y. and Chanda, Prateek and Glogowski, Kolja and Hewett, Russell and Hughitt, V. Keith and Hill, Andrew and Hiware, Kaustubh and Inglis, Andrew and Kirk, Michael S. F. and Konge, Sudarshan and Mason, James Paul and Maloney, Shane Anthony and Murray, Sophie A. and Panda, Asish and Park, Jongyeob and Pereira, Tiago M. D. and Reardon, Kevin and Savage, Sabrina and Sipőcz, Brigitta M. and Stansby, David and Jain, Yash and Taylor, Garrison and Yadav, Tannmay and Rajul and Dang, Trung Kien},
      title = {The SunPy Project: Open Source Development and Status of the Version 1.0 Core Package},
      journal = {The Astrophysical Journal},
      volume = {890},
      issue = {1},
      pages = {68-},
      publisher = {American Astronomical Society},
      year = {2020}
    }

You can also get this information with ``sunpy.__citation__``.

Other SunPy publications
########################

- :cite:t:`sunpy_community_sunpypython_2015` --- First paper describing sunpy v0.5

- :cite:t:`mumford_sunpy_2020` --- JOSS review of sunpy v1.0.8

- :cite:t:`the_sunpy_community_sunpy_2023` --- Description of the SunPy Project

Acknowledging SunPy in Posters and Talks
----------------------------------------

Please include the `Sunpy logo`_ on the title, conclusion slide, or about page.
For websites please link the image to `sunpy.org`_.
Other versions of the logo are available in the `sunpy-logo repository`_.

.. _Sunpy logo: https://github.com/sunpy/sunpy-logo/blob/master/sunpy_logo.svg
.. _sunpy.org: https://sunpy.org/
.. _sunpy-logo repository: https://github.com/sunpy/sunpy-logo/
.. _Zenodo DOI: https://doi.org/10.5281/zenodo.591887
