Merge pull request #12 from BlackHolePerturbationToolkit/citation

Citation

CITATION.cff

@@ -0,0 +1,34 @@
+cff-version: "1.2.0"
+authors:
+- family-names: Park
+  given-names: Seyong
+  orcid: "https://orcid.org/0009-0002-1152-9324"
+- family-names: Nasipak
+  given-names: Zachary
+  orcid: "https://orcid.org/0000-0002-5109-9704"
+doi: 10.5281/zenodo.11386563
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+preferred-citation:
+  authors:
+  - family-names: Park
+    given-names: Seyong
+    orcid: "https://orcid.org/0009-0002-1152-9324"
+  - family-names: Nasipak
+    given-names: Zachary
+    orcid: "https://orcid.org/0000-0002-5109-9704"
+  date-published: 2024-06-01
+  doi: 10.21105/joss.06587
+  issn: 2475-9066
+  issue: 98
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 6587
+  title: "KerrGeoPy: A Python Package for Computing Timelike Geodesics
+    in Kerr Spacetime"
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.06587"
+  volume: 9
+title: "`KerrGeoPy`: A Python Package for Computing Timelike Geodesics
+  in Kerr Spacetime"

README.md

@@ -5,6 +5,9 @@
 [![Documentation Status](https://readthedocs.org/projects/kerrgeopy/badge/?version=latest)](https://kerrgeopy.readthedocs.io/en/latest/?badge=latest)
 [![GitHub License](https://img.shields.io/github/license/BlackHolePerturbationToolkit/KerrGeoPy)](https://github.com/BlackHolePerturbationToolkit/KerrGeoPy/blob/main/LICENSE)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8417442.svg)](https://doi.org/10.5281/zenodo.8417442)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.06587/status.svg)](https://doi.org/10.21105/joss.06587)
+[![DOI](https://img.shields.io/badge/arXiv-2406.01413-B31B1B)](https://arxiv.org/abs/2406.01413)
+
 
 # KerrGeoPy
 
@@ -295,7 +298,22 @@ plt.ylabel(r"$\phi(\lambda)$")
 
 ![png](https://raw.githubusercontent.com/BlackHolePerturbationToolkit/KerrGeoPy/main/README_files/Getting%20Started_20_1.png)
 
-
+## Citation
+If you use this software, please cite our article in the Journal of Open Source Software.
+```
+@article{kerrgeopy, 
+doi = {10.21105/joss.06587}, 
+url = {https://doi.org/10.21105/joss.06587}, 
+year = {2024}, 
+publisher = {The Open Journal}, 
+volume = {9}, 
+number = {98}, 
+pages = {6587}, 
+author = {Seyong Park and Zachary Nasipak}, 
+title = {KerrGeoPy: A Python Package for Computing Timelike Geodesics in Kerr Spacetime}, 
+journal = {Journal of Open Source Software} 
+} 
+```
 ## Authors
 
 * Seyong Park