Skip to content

Commit d2c06b6

Browse files
authored
Merge pull request #156 from coderefinery/eglerean-patch-1
Adding a box about FAIR4RS
2 parents f21b4b4 + d3b221f commit d2c06b6

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

content/software-citation.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,3 +109,21 @@ software citation examples):
109109
- Identifier
110110
- Version
111111
- Type
112+
113+
114+
```{admonition} FAIR for Research Software (FAIR4RS)
115+
The FAIR4RS Principles adapt the original FAIR data principles to improve the **Findability, Accessibility, Interoperability, and Reusability** of research software. They provide guidelines to make research software more open, discoverable, citable, and reusable, which supports reproducibility and open science. The summary of the FAIR4RS below is a compressed version of the principles listed in [Barker, Michelle, et al. "Introducing the FAIR Principles for research software." Scientific Data 9.1 (2022): 622](https://www.nature.com/articles/s41597-022-01710-x).
116+
117+
- **Findable**: Software should have a globally unique and persistent identifier
118+
(e.g. clear versioning of releases, DOI from Zenodo when depositing a software release, software metadata in citation file).
119+
- **Accessible**: Software and metadata should be retrievable using open protocols
120+
(e.g. downloading from GitHub or Zenodo).
121+
- **Interoperable**: Software should use open formats and standards to work with other tools
122+
(e.g. input/output files in CSV, dependencies listed in `requirements.txt` or `environment.yml`, configuration files in yaml).
123+
- **Reusable**: Software should have clear licensing, documentation, and provenance
124+
(e.g. a standard license and a `README` with usage instructions, authors listed with ORCIDs).
125+
126+
There are great resources to self-evaluate the *FAIRness* of your research software:
127+
- [FAIR Software Checklist](https://fairsoftwarechecklist.net/) which provides a questionnaire and even a badge of how FAIR the software is
128+
- [FAIR Software NL](https://fair-software.nl/) highlights with nice visuals the five most important elemnts of FAIR4RS (1. Public accessible repository with version control; 2. License; 3. Software registry; 4. Software citation file; 5. Software quality checklist)
129+
```

0 commit comments

Comments
 (0)