-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Citation Section to Documentation for XRTpy (#294)
* new section in the documentation to cite xrtpy * Updating index with citation_guide" * Correction, name of rst file * Adding suggestion for cite methods * Updating title of doc page name * length correction * Trying to fix length for rst format * Working on format for doc test * match the length of the title text * match the length of the title text-p2
- Loading branch information
1 parent
7efbf81
commit 775161a
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,3 +10,4 @@ Contributor Guide | |
contributing | ||
installation_for_development | ||
release_guide | ||
acknowledging_xrtpy |