Are others using software you’ve written in their research and citing it as you want it to be cited? If not, this poster will help! Software can be cited in different ways, some good, and some not good at all for tracking and counting citations in indexers such as ADS and Google Scholar. Generally, indexers need to match citations to resources, such as journal articles, they ingest. There are several reasons why your code might not be cited well (in a trackable/countable way). One common reason is the lack of clear and explicit instructions on a code’s download site. Most astro code sites don’t list a preferred citation method! Make it easy for people to cite your software by listing a (good! trackable!) preferred citation method where others can easily find it. Creating a standard software metadata file, such as a CITATION.cff or codemeta.json, and adding it to the root of your code repo is easy to do with the ASCL’s metadata file creation overlay (see handout below), and will help out anyone wanting to give you credit for your computational method, whether it’s a huge carefully-written and tested package, or a short quick-and-dirty-but-oh-so-useful code.
This morning, I gave a tutorial on the ASCL at ADASS XXXII, which is being held virtually from the University of Toronto and the University of Victoria. I’ll write more extensively about ADASS later this week; it is, as always, a fabulous conference with a lot of great work, talks, software, data, discussion, posters, chats, demos, tutorials… well, a lot! It’s my favorite astro conference.
But for now, slides from the tutorial are below. Thanks to ADASS for accepting the proposal and to the participants for attending and for all the interesting (and occasionally scary!) comments and questions!
Did you know you can download all the ASCL’s entries? You can! If you want all accepted entries: https://ascl.net/code/json
If you want particular fields, use an API query. This query brings up ASCL ID, title, bibcode, and when the entry was last updated.
Want only entries that list a preferred citation? This will do it: https://ascl.net/api/search/?q=citation_method:%22.%22&fl=ascl_id,title,bibcode,citation_method
Find more info on our API here: https://github.com/teuben/ascl-tools/tree/master/API
If you’d like to know more about our metadata schema, please see this page: https://ascl.net/wordpress/about-ascl/metadata-schema/
You can also search ADS (https://ui.adsabs.harvard.edu) for ASCL entries by searching for bibstem:ascl.soft
Click the ADS Explore button on screen right and you can play with all kinds of info about ASCL entries, including citation metrics and concept clouds. Is there something else you’d like to see, another way you’d like ASCL entry data? Please let us know!
This week, I’m attending and speaking at the ESO-sponsored Reproducibility and Open Science in Astronomy workshop. The first day was fabulous! The workshop runs through Thursday.
My talk is Opening the computational box: software sharing and the ASCL, and the abstract and links to resources mentioned in the talk are below.
Though computational methods are widely used in many disciplines, many researchers do not share the source code they develop, making their research difficult to verify and replicate. This presentation focuses on what software users and authors can do to share codes effectively, increase research reproducibility, and meet new requirements established by funders and journals. It will also cover how the Astrophysics Source Code Library (ASCL) improves the transparency of science by registering research code, its efforts to increase software findability, and how astronomers can get credit for their codes and better support the research record.
Journal of Open Source Software (JORS)
Astronomy and Computing (A&C)
Journal of Open Source Software (JOSS)
Computing and Software for Big Science
Research Notes of the AAS
Change leaders, guidelines, and tools
SciCodes/Nine Best Practices for Software Registries and Repositories
FORCE11/FORCE11 Software Citation Principles
Research Data Alliance/FAIR for Research Software (FAIR4RS) WG
CITATION file format (CFF)/CFF INIT
Social coding sites and archival services
Other resources and fun links
arXiv/arXiv Next Generation
All ASCL entries in JSON
Generating software metadata files from an ASCL entry:
How many GitHub repos have CITATON.cff files/codemeta.json files?