Improving Software Citation and Credit
The past year has seen movement on several fronts for improving software citation, including the Center for Open Science’s Transparency and Openness Promotion (TOP) Guidelines, the Software Publishing Special Interest Group that was started at January’s AAS meeting in Seattle at the request of that organization’s Working Group on Astronomical Software, a Sloan-sponsored meeting at GitHub in San Francisco to begin work on a cohesive research software citation-enabling platform, the work of Force11 to “transform and improve” research communication, and WSSSPE’s ongoing efforts that include software publication, citation, credit, and sustainability.
Brief reports on these efforts were shared at the BoF, after which participants discussed ideas for improving software citation, generating a list of recommendations to the community of software authors, journal publishers, ADS, and research authors. The discussion, recommendations, and feedback will help form recommendations for software citation to those publishers represented in the Software Publishing Special Interest Group and the broader community.
Alice Allenaallen@ascl.netAstrophysics Source Code Library \paperauthorG. Bruce Berrimangbb@ipac.caltech.eduorcid.org/0000-0001-8388-534XCalifornia Institute of TechnologyIPACPasadenaCA91125USA \paperauthorKimberly DuPriekduprie@stsci.eduSpace Telescope Science Institute \paperauthorJessica Minkjmink@cfa.harvard.eduorcid.org/0000-0003-3594-1823Harvard-Smithsonian Center for Astrophysics \paperauthorRobert Nemiroffnemiroff@mtu.eduorcid.org/0000-0002-4505-6599Michigan Technological University\paperauthorThomas Robitaillerobitaille@mpia.deorcid.org/0000-0002-8642-1329Max Planck Institute for Astronomy Heidelberg D-69117Germany \paperauthorLior Shamirlshamir@ltu.eduorcid.org/0000-0002-6207-1491Lawrence Technological University\paperauthorKeith Shortridgeks@aao.gov.auAustralian Astronomical Observatory \paperauthorMark TaylorM.B.Taylor@bristol.ac.ukUniversity of Bristol \paperauthorPeter Teubenteuben@astro.umd.eduorcid.org/0000-0003-1774-3436University of Maryland \paperauthorJohn WallinJohn.Wallin@mtsu.eduorcid.org/0000-0001-5678-8325Middle Tennessee State University
Providing credit to code authors through citation has been a recurring topic in previous Birds of a Feather (BoF) sessions sponsored by the Astrophysics Source Code Library (ASCL)
The BoF opened with a short presentation by Bruce Berriman and Alice Allen. Berriman described a Software Publishing Special Interest Group (SPSIG) meeting held by the ASCL at the American Astronomical Society (AAS) meeting in January 2015 to discuss software citation; the SPSIG was formed at the request of the AAS’s Working Group on Astronomical Software (WGAS). The meeting was attended by publishers and editors from AAS journals, Springer, IOP, Cambridge University Press and Oxford University Press, software authors, representatives from the Astrophysics Data System (ADS)
Allen reported on recent efforts by software citation workgroups formed at the 3rd Workshop on Sustainable Software for Science: Practice and Experiences (WSSSPE3)
2 Group Discussion
The very lively discussion among the 40 attendees was moderated by Keith Shortridge; a Google document
A recent experiment among some journals to request code with papers, requiring a code author to provide a tarball of the software and turn over copyright of it to a publisher, was discussed with vigor. This practice did not receive any support among those assembled, and later (and ongoing) discussion made clear how concerned software authors are about this path. Indeed, this practice was unanimously condemned.
The need to make a distinction between publishing software and making it available – releasing it – was discussed and then a request for the group to start focusing on possible recommendations and actionable suggestions was made and followed.
3 Ideas from the Collected Masses
Some of the suggestions made for improving software citation and credit were directed to specific parts of the community to do or to use, whereas others were more general or assumed to be for the ASCL or other entities involved in software, and included:
For authors: Provide information as to what software should be cited. Cite the first-level software; a manuscript author is not responsible for citing software dependencies unless there are specific instructions from first-level software author for citing them.
For authors: Do not cite GitHub directly. Use Internet Archive, ASCL, Zenodo, Figshare, etc.
For publishers: Do not count references against the word count.
For ADS: Include software in categorization of entries.
For the community: Encourage your university to ask about software on the annual research activity report.
For the community: Write a wiki article for AstroBetter and the AAS newsletter and other places on how to release software for citation, and how to cite software.
For the community: Create and award a prize for software contributions.
For the community: Create a video on how to release and cite software effectively.
For the community: Collect and publish stories from people who have released their software and what their views are on releasing software.
Clearly there is a role for each person in the community to contribute to the goal of improving software citation and credit. Software authors can release their codes, follow one of several paths for making their code easily citable, and specify clearly and obviously how they want their software cited. Researchers using software in their work can cite computational methods as their authors specify, and journal editors can insist that codes be cited properly in the manuscripts they accept. Publishers can require software citations that are properly formatted so indexers can pick up and track the citations, and can remove length restrictions that prohibit methods citations. Those serving the community, such as ADS and ASCL, can promote better software citation by sharing information about citations and encouraging the community to improve, and individuals can push for inclusion of software activities in consideration for promotions and tenure.
Our thanks to all the attendees for their comments, ideas, and advocacy, to the ADASS POC for accepting our BoF proposal, and to Keith Shortridge for moderating the spirited discussion.
- Allen, A., Berriman, B., Brunner, R., Burger, D., DuPrie, K., Hanisch, R. J., Mann, R., Mink, J., Sandin, C., Shortridge, K., & Teuben, P. 2013, in Astronomical Data Analysis Software and Systems XXII, edited by D. N. Friedel, vol. 475 of Astronomical Society of the Pacific Conference Series, 383. 1212.1915
- Hanisch, R. J., Berriman, G. B., Lazio, T. J. W., Emery, S., Evans, J. ., McGlynn, T. A., & Plante, R. A. 2015, Astronomy and Computing, 11, 190
- Teuben, P., Allen, A., Berriman, B., DuPrie, K., Hanisch, R. J., Mink, J., Nemiroff, R. J., Shamir, L., Shortridge, K., Taylor, M. B., & Wallin, J. F. 2014, in Astronomical Data Analysis Software and Systems XXIII, edited by N. Manset, & P. Forshay, vol. 485 of Astronomical Society of the Pacific Conference Series, 3. 1312.7352