Managing your research software

Research software includes source code files, algorithms, scripts, computational workflows and executables that were created during the research process or for a research purpose.  

If research software is part of your research output, it is crucial for the scientific integrity and recognition of your research to describe, maintain and archive your original work. At Radboud University we work in line with the FAIR principles (Findable, Accessible, Interoperable, Reusable), which also apply to software. 

Store and publish software

Software is dynamic and requires proper documentation throughout the research process. Setting up your software management early in your research will save time and strengthen the quality and credibility of your research software. Detailed descriptions and metadata are needed to ensure findability, reproducibility, and interoperability. It is also common for software to be developed further after related articles and datasets have been published. Below are several important steps to help you move in the right direction:

1. Version control 

Store and update your work on a publicly accessible repository with version control, for example GitHub or GitLab. While the software evolves through contributions from yourself and your collaborators, it tracks the changes and keeps all versions available.

2. Document 

Make sure the software is accompanied by all relevant metadata and instructions. You can do so by including a README file. Create persistent identifiers (DOI, URK, ARK etc.) for all versions of the software so these can be cited. It is possible to automatically assign each version with an identifier, by linking GitHub with Zenodo.

3. Choose a license

A license determines the conditions under which your software can be accessed, edited, and reused. Use the decision tree to choose the right license for your project. 

4. Archive and publish 

Ensure that software is preserved for the long-term by archiving -and optionally publishing- in the Radboud Data Repository (and if applicable other trustworthy repositories relevant to your scientific field). By publishing the software, you will also ensure that others can find your work (persistently).  

Contact

Do you have questions? Please contact the Digital Competence Centre.