Improving Software Citation and Credit

Improving Software Citation and Credit

Alice Allen, G. Bruce Berriman, Kimberly DuPrie, Jessica Mink, Robert Nemiroff, Thomas Robitaille, Lior Shamir, Keith Shortridge, Mark Taylor, Peter Teuben, and John Wallin Astrophysics Source Code Library Infrared Processing and Analysis Center, California Institute of Technology Space Telescope Science Institute Harvard-Smithsonian Center for Astrophysics Michigan Technological University Max Planck Institute for Astronomy Lawrence Technological University Australian Astronomical Observatory University of Bristol University of Maryland Middle Tennessee State University

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.

1 Introduction

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)111 at ADASS meetings: (Bring out your codes! Bring out your codes! (2013ASPC..475..383A) and Ideas for advancing code sharing (2014ASPC..485....3T). This BoF continued the work started at previous BoFs on that topic, and represents a topic being addressed by the ASCL at astronomy software sessions and topical meetings.

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)222, GitHub and projects such as the Large Synoptic Survey Telescope (LSST), researchers, and others. Berriman summarized a working Google document333 that captured the deliberations at that meeting (essentially, a summary of the current state of software citation in astronomy). He also presented opinions on what constitutes a citable work, the difference between attribution and citation, and a restatement of the distinction between citation and attribution by Christine Borgman.

Allen reported on recent efforts by software citation workgroups formed at the 3rd Workshop on Sustainable Software for Science: Practice and Experiences (WSSSPE3)444 and Force11;555 as these efforts are very similar, the WSSSPE group has now joined the Force11 efforts. She also reported on the Center for Open Science’s Transparency and Openness Promotion (TOP) Guidelines666 and a Sloan-sponsored meeting at GitHub in San Francisco to begin work on a cohesive research software citation-enabling platform. The slides from Berriman’s and Allen’s presentation are available online,777 as are other resources and links.888

2 Group Discussion

The very lively discussion among the 40 attendees was moderated by Keith Shortridge; a Google document999 captured some of the discussion and was later shared and augmented by some of the attendees. Different citation methods mentioned in Berriman’s presentation were discussed; a software description paper has been the most common way to cite software that has been used in a research project. Even with a software description paper available to use for citation, many codes used in research do not receive a formal citation in research papers. Alberto Accomazzi pointed this out by pulling some quick statistics from ADS for the DAOPHOT package, and reported that the DAOPHOT code description paper has over 3,000 citations to it, yet the software is mentioned in more than 6,000 papers. Accomazzi supplied more exact numbers after the meeting: as of November 11, the DAOPHOT code description paper had 4,035 formal citations and the software was mentioned in 3,061 papers that did not cite it formally. It has been previously noted that quantitative measures of the impact of software on the astronomy community are hard to derive in the absence of a culture of citation: e.g., “… although some 22,000 peer-reviewed papers mention the VLA radio telescope, only 68 formally acknowledge the use of AIPS and only 59 acknowledge use of CASA, the two dominant reduction and analysis packages for radio interferometry data.”(2015A&C....11..190H)

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.

4 Conclusions

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.



Comments 0
Request Comment
You are adding the first comment!
How to quickly get a good reply:
  • Give credit where it’s due by listing out the positive aspects of a paper before getting into which changes should be made.
  • Be specific in your critique, and provide supporting evidence with appropriate references to substantiate general statements.
  • Your comment should inspire ideas to flow and help the author improves the paper.

The better we are at sharing our knowledge with each other, the faster we move forward.
The feedback must be of minimum 40 characters and the title a minimum of 5 characters
Add comment
Loading ...
This is a comment super asjknd jkasnjk adsnkj
The feedback must be of minumum 40 characters
The feedback must be of minumum 40 characters

You are asking your first question!
How to quickly get a good answer:
  • Keep your question short and to the point
  • Check for grammar or spelling errors.
  • Phrase it like a question
Test description