All Images

Introduction: Software as a Citable Research Output


Sharing Research Software Effectively


Choosing an Open-Source License


Figure 1

GitHub's create-new-file page in the software-demo repository, with the filename field set to LICENSE and the 'Choose a license template' button both highlighted.
Name the new file LICENSE, then click Choose a license template to insert the full BSD 3-Clause text.

Adding a CITATION.cff File


Figure 1

GitHub's create-new-file editor with the filename CITATION.cff, the Insert example button, the template in the edit pane, and the Commit changes button all highlighted and numbered one through four.
Name a new file CITATION.cff, click Insert example to drop in GitHub’s template, edit the placeholder names and ORCIDs, then commit to main.

Figure 2

A GitHub repository sidebar with the 'Cite this repository' link highlighted and its citation panel open, showing APA and BibTeX tabs.
Once CITATION.cff is on the default branch, GitHub adds a Cite this repository link to the About sidebar that opens ready-made APA and BibTeX citations.

Making Your Software Citable


Figure 1

Zenodo Sandbox 'Get started' panel showing three numbered steps: Flip the switch, Create a release, and Get the badge.
Zenodo’s GitHub page walks you through the same three steps: flip the switch on a repository, create a release, and get a DOI badge.

Figure 2

Zenodo Sandbox GitHub repositories list with the software-demo row highlighted and its toggle switched ON.
In Zenodo Sandbox under Settings → GitHub, find your repository and flip its switch to ON so Zenodo archives each new release.

Figure 3

GitHub's Draft a new release form with the tag selector, release title field, and release notes editor highlighted and numbered one through three.
On GitHub’s “Draft a new release” form: choose or create a tag such as v0.1.0, add a release title, describe what’s in the release, then click Publish release (below the fold).

Improving Metadata and Discoverability


Figure 1

GitHub's 'Edit repository details' dialog with the Topics field highlighted, showing example topics such as biodiversity, ecology, and data-analysis.
Open the repository’s About settings (the gear icon) and add topics in the Topics field, separated by spaces.

Managing Reproducible Environments with pixi


Wrap-Up and Reflection