Merge pull request #745 from pyvisa/joss-paper

Add citing information to README and GitHub Citation

CITATION.cff

@@ -0,0 +1,50 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Grecco"
+  given-names: "Hernán E."
+  orcid: "https://orcid.org/0000-0002-1165-4320"
+- family-names: "Dartiailh"
+  given-names: "Matthieu C."
+  orcid: "https://orcid.org/0000-0001-6451-0577"
+- family-names: "Thalhammer-Thurner"
+  given-names: "Gregor"
+  orcid: "https://orcid.org/0000-0002-3948-8045"
+- family-names: "Bronger"
+  given-names: "Torsten"
+  orcid: "https://orcid.org/0000-0002-5174-6684"
+- family-names: "Bauer"
+  given-names: "Florian"
+  orcid: "https://orcid.org/0009-0004-5271-5363"
+title: "PyVISA"
+version: 1.13.0
+doi: 10.5281/zenodo.7868199
+date-released: 2022-12-22
+url: "https://github.com/github-linguist/linguist"
+preferred-citation:
+  type: article
+  authors:
+  - family-names: "Grecco"
+    given-names: "Hernán E."
+    orcid: "https://orcid.org/0000-0002-1165-4320"
+  - family-names: "Dartiailh"
+    given-names: "Matthieu C."
+    orcid: "https://orcid.org/0000-0001-6451-0577"
+  - family-names: "Thalhammer-Thurner"
+    given-names: "Gregor"
+    orcid: "https://orcid.org/0000-0002-3948-8045"
+  - family-names: "Bronger"
+    given-names: "Torsten"
+    orcid: "https://orcid.org/0000-0002-5174-6684"
+  - family-names: "Bauer"
+    given-names: "Florian"
+    orcid: "https://orcid.org/0009-0004-5271-5363"
+  doi: "10.21105/joss.05304"
+  journal: "Journal of Open Source Software"
+  month: 4
+  start: 5304
+  end: 5308 
+  title: "PyVISA: the Python instrumentation package"
+  issue: 84
+  volume: 8
+  year: 2023

README.rst

@@ -23,6 +23,9 @@ PyVISA
 .. image:: https://img.shields.io/pypi/v/PyVISA
     :target: https://pypi.python.org/pypi/pyvisa
     :alt: PyPI
+.. image:: https://joss.theoj.org/papers/10.21105/joss.05304/status.svg
+   :target: https://doi.org/10.21105/joss.05304
+
 
 A Python package for support of the "Virtual Instrument Software
 Architecture" (VISA), in order to control measurement devices and
@@ -48,10 +51,10 @@ The VISA specification has explicit bindings to Visual Basic, C, and G
 VISA shared library (`.dll`, `.so`, `.dylib`) allowing to directly leverage the
 standard implementations. In addition, Python can be used to directly access
 most bus systems used by instruments which is why one can envision to implement
-the VISA standard directly in Python (see the `PyVISA-Py` project for more
+the VISA standard directly in Python (see the `PyVISA-Py`_ project for more
 details). PyVISA is both a Python wrapper for VISA shared libraries but
 can also serve as a front-end for other VISA implementation such as
-`PyVISA-Py`.
+`PyVISA-Py`_.
 
 
 .. _VISA: http://www.ivifoundation.org/specifications/default.aspx
@@ -99,3 +102,14 @@ Documentation
 --------------
 
 The documentation can be read online at https://pyvisa.readthedocs.org
+
+
+Citing
+------
+
+If you are using this package, you can cite the `PyVISA publication`_ 
+
+Grecco et al., (2023). PyVISA: the Python instrumentation package. Journal of Open Source 
+Software, 8(84), 5304, https://doi.org/10.21105/joss.05304
+
+.. _`PyVISA publication`: https://joss.theoj.org/papers/10.21105/joss.05304#

joss-paper/paper.bib

@@ -0,0 +1,72 @@
+@article{Cheij:2002,
+  author={Cheij, D.},
+  journal={IEEE Aerospace and Electronic Systems Magazine}, 
+  title={Software architecture for building}, 
+  year={2002},
+  volume={17},
+  number={1},
+  pages={27-30},
+  doi={10.1109/62.978361}
+}
+
+@book{Oliphant:2015,
+  author={Oliphant, T.E.},
+  title={Guide to NumPy: 2nd Edition},
+  publisher={CreateSpace Independent Publishing Platform},
+  year=2015 
+}
+
+@misc{pyvisa:github,
+  author = {{The PyVISA authors}},
+  title = {PyVISA: A {Python} package for support of the {Virtual} {Instrument} {Software} {Architecture}},
+  year = {2020},
+  publisher = {GitHub},
+  url = {https://github.com/pyvisa/pyvisa}
+}
+
+@misc{pyvisa:docs,
+  author = {{The PyVISA authors}},
+  title = {PyVISA: A {Python} package for support of the {Virtual} {Instrument} {Software} {Architecture}},
+  year = {2020},
+  publisher = {Read the Docs},
+  url = {https://pyvisa.readthedocs.io}
+}
+
+@misc{pep:492,
+  author = {Selivanov, Y.},
+  title = {PEP 492 – Coroutines with async and await syntax},
+  year = {2015},
+  publisher = {{Python}},
+  journal = {{Python}},
+  url = {https://peps.python.org/pep-0492/}
+}
+
+@article{Enke:1982,
+  doi = {10.1126/science.215.4534.785},
+  author = {C. G. Enke },
+  title = {Computers in Scientific Instrumentation},
+  journal = {Science},
+  volume = {215},
+  number = {4534},
+  pages = {785-791},
+  year = {1982},
+  doi = {10.1126/science.215.4534.785},
+  URL = {https://www.science.org/doi/abs/10.1126/science.215.4534.785},
+  eprint = {https://www.science.org/doi/pdf/10.1126/science.215.4534.785},
+}
+
+@article{raymond:1999,
+	title = {The Cathedral and the Bazaar},
+	volume = {12},
+	issn = {1874-6314},
+	url = {https://doi.org/10.1007/s12130-999-1026-0},
+	doi = {10.1007/s12130-999-1026-0},
+	language = {en},
+	number = {3},
+	urldate = {2023-04-24},
+	journal = {Know Techn Pol},
+	author = {Raymond, Eric},
+	month = sep,
+	year = {1999},
+	pages = {23--49},
+}