Merge pull request #259 from dstansby/citing-info

Add citation info
dstansby · Oct 27, 2020 · e77b037 · e77b037
2 parents 6efe65f + e55b762
commit e77b037
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 11 deletions.
diff --git a/CITING.rst b/CITING.rst
@@ -0,0 +1,21 @@
+Citing
+------
+
+If you use pfsspy in work that results in publication, please cite the
+Journal of Open Source Software paper at https://doi.org/10.21105/joss.02732.
+A ready made bibtex entry is
+
+.. code:: bibtex
+
+  @article{Stansby2020,
+    doi = {10.21105/joss.02732},
+    url = {https://doi.org/10.21105/joss.02732},
+    year = {2020},
+    publisher = {The Open Journal},
+    volume = {5},
+    number = {54},
+    pages = {2732},
+    author = {David Stansby and Anthony Yeates and Samuel T. Badman},
+    title = {pfsspy: A Python package for potential field source surface modelling},
+    journal = {Journal of Open Source Software}
+  }
diff --git a/doc/source/changes.rst b/doc/source/changes.rst
@@ -3,6 +3,10 @@
 Changelog
 =========
 
+0.6.4
+-----
+This release adds citation information to the documentation.
+
 0.6.3
 -----
 This release contains the source for the accepted JOSS paper describing pfsspy.

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -30,17 +30,7 @@ improve code performance. These can be installed with
 
     pip install pfsspy[performance]
 
-Citing
-------
-
-If you use pfsspy in work that results in publication, please cite the archived
-code at *both*
-
-  - https://zenodo.org/record/2566462
-  - https://zenodo.org/record/1472183
-
-Citation details can be found at the lower
-right hand of each web page.
+.. include:: ../../CITING.rst
 
 Contents
 --------

diff --git a/pfsspy/__init__.py b/pfsspy/__init__.py
@@ -26,3 +26,19 @@
         distutils.version.LooseVersion("3")):
     raise RuntimeError('pfsspy requires astropy v3 to run ' +
                        f'(found version {astropy.__version__} installed)')
+
+
+__citation__ = __bibtex__ = """
+@article{Stansby2020,
+doi = {10.21105/joss.02732},
+url = {https://doi.org/10.21105/joss.02732},
+year = {2020},
+publisher = {The Open Journal},
+volume = {5},
+number = {54},
+pages = {2732},
+author = {David Stansby and Anthony Yeates and Samuel T. Badman},
+title = {pfsspy: A Python package for potential field source surface modelling},
+journal = {Journal of Open Source Software}
+}
+"""