Skip to content
This repository has been archived by the owner on Aug 24, 2023. It is now read-only.

Commit

Permalink
Add citation info
Browse files Browse the repository at this point in the history
  • Loading branch information
dstansby committed Oct 23, 2020
1 parent 6efe65f commit bd610dc
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 11 deletions.
21 changes: 21 additions & 0 deletions CITING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Citing
------

If you use pfsspy in work that results in publication, please cite the
Journal of Open Source Science 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}
}
12 changes: 1 addition & 11 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand Down
16 changes: 16 additions & 0 deletions pfsspy/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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}
}
"""

0 comments on commit bd610dc

Please sign in to comment.