diff --git a/docs/contributing/acknowledging_xrtpy.rst b/docs/contributing/acknowledging_xrtpy.rst new file mode 100644 index 000000000..3b371b075 --- /dev/null +++ b/docs/contributing/acknowledging_xrtpy.rst @@ -0,0 +1,30 @@ +.. _citation_guide: + +=============================================== +Citing XRTpy in Publications and Presentations +=============================================== + + +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. + +Suggested Citations +=================== + +For a scientific paper +---------------------- +You may use the following format to cite XRTpy in your publications: + + "We acknowledge the use of XRTpy (v0.4.1) for Hinode X-Ray Telescope data analysis, available at https://xrtpy.readthedocs.io/ (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: + + "This work made use of XRTpy (v0.4.1), a Python package for solar + Hinode X-Ray Telescope data analysis, available at https://xrtpy.readthedocs.io/ (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 + +.. _joss_citation: https://doi.org/10.21105/joss.06396 diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index ae1f2272f..f7530cd26 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -10,3 +10,4 @@ Contributor Guide contributing installation_for_development release_guide + acknowledging_xrtpy