From bd610dc542a99f0ef6c64356dae501b345d2a55a Mon Sep 17 00:00:00 2001 From: David Stansby Date: Fri, 23 Oct 2020 17:29:21 +0100 Subject: [PATCH 1/2] Add citation info --- CITING.rst | 21 +++++++++++++++++++++ doc/source/index.rst | 12 +----------- pfsspy/__init__.py | 16 ++++++++++++++++ 3 files changed, 38 insertions(+), 11 deletions(-) create mode 100644 CITING.rst diff --git a/CITING.rst b/CITING.rst new file mode 100644 index 00000000..893db833 --- /dev/null +++ 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 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} + } diff --git a/doc/source/index.rst b/doc/source/index.rst index 752a6cb7..c850da1e 100644 --- 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 index b5e9f10f..e97e3d63 100644 --- 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} +} +""" From e55b7627077fa4c13613cc029bf4a483b7f2e8c5 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Tue, 27 Oct 2020 20:53:28 +0000 Subject: [PATCH 2/2] Update changelog --- CITING.rst | 2 +- doc/source/changes.rst | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CITING.rst b/CITING.rst index 893db833..f589b6e3 100644 --- a/CITING.rst +++ b/CITING.rst @@ -2,7 +2,7 @@ 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. +Journal of Open Source Software paper at https://doi.org/10.21105/joss.02732. A ready made bibtex entry is .. code:: bibtex diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 52870650..85ccc907 100644 --- 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.