.. _xrtpy-citation:

************
Citing XRTpy
************

If XRTpy has been useful in your research, we encourage you to consider including a citation or acknowledgment in your work.
Below are suggested formats to credit XRTpy in your scientific papers, posters, or presentations.
While this is not required, it is greatly appreciated.


For a scientific paper
======================

You may use the following format to cite XRTpy in your publications:

.. code-block:: text

    "We acknowledge the use of XRTpy (v0.5.0) for Hinode X-Ray Telescope data analysis, available at https://xrtpy.readthedocs.io/en/latest/ (Velasquez et al. 2024, JOSS, DOI: 10.21105/joss.06396)."


For a poster or presentation
============================

If you are presenting work that involves XRTpy in a poster or presentation, you may use the following acknowledgment:

.. code-block:: text

    "This work made use of XRTpy (v0.5.0), a Python package for solar
    Hinode X-Ray Telescope data analysis, available at https://xrtpy.readthedocs.io/en/latest/ (Velasquez et al. 2024, JOSS, DOI: 10.21105/joss.06396)."

References
==========

Velasquez, J., Murphy, N., Reeves, K. K., Slavin, J., Weber, M., & Barnes, W. (2024). XRTpy: A Hinode-X-Ray Telescope Python Package. The Journal of Open Source Software, 9(100), 6396. https://doi.org/10.21105/joss.06396