rseng-fair-software

Solid

Covers how to apply the FAIR principles - findable, accessible, interoperable, reusable - to research software, and how to assess a project's FAIRness. Use when the user asks how to make software FAIR, wants help with findability, discoverability, or software reuse, mentions metadata, persistent identifiers, DOIs, registries, or software citation in a FAIR context, or asks to run a FAIR self-assessment or checklist on a repository. (Automated FAIR4RS scoring, compliance levels and CI gates with the FAIRGuard tool are rseng-fairguard; FAIR for ML models and datasets is rseng-fair-ml; finding existing software to reuse is rseng-software-reuse.)

AI & Automation 14 stars 2 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
39
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# FAIR research software Use this skill when someone wants their software to be Findable, Accessible, Interoperable, and Reusable, or when reviewing how well a project meets those principles. FAIR is a set of principles for increasing the visibility and usefulness of research to others; the data principles from 2016 now extend to software, workflows, and machine-learning projects. Treat FAIR as one subset of overall software quality: it ensures software can be discovered, understood, and rerun by others (or by the author months later), but it says nothing about whether the software is correct - pair it with testing and the other quality dimensions. Work through the four principles below. Each maps to concrete actions; recommend the ones a project is missing, and explain why each matters as you go. Many actions serve more than one principle, so a single change (good metadata, a DOI, a license) often lifts several at once. ## Make software Findable Software and its metadata must be easy to discover by humans and machines. Recommend: - Write a machine-readable description (metadata) of the software so search engines and tools can index it. Use a standard such as CodeMeta rather than an ad-hoc format, following the Research Software Metadata Guidelines. - Put the code in a public repository (for example GitHub or GitLab) and, ideally, register it in a general-purpose or domain-specific registry (for example bio.tools for the biosciences). The Awesome Research Sof...

Details

Author
fdiblen
Repository
fdiblen/rseng-agent-skills
Created
4 days ago
Last Updated
4 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

rseng-fair-ml

Covers applying FAIR principles to machine learning artifacts: making models findable and reusable with model cards and rich repository metadata, documenting datasets with Croissant and datasheet-style records, licensing models and weights, linking the model-data-code-paper cluster with persistent identifiers, and the RDA FAIR4ML metadata direction. Use when a project trains, fine-tunes, publishes or reuses ML models or ML-ready datasets, when the user mentions model cards, Croissant, datasheets, FAIR4ML or model licensing, when a model heads to a hub or archive, or when evaluating whether a third-party model is documented well enough to build on. (General software FAIR is rseng-fair-software; automated repository scoring is rseng-fairguard.)

14 Updated 4 days ago
fdiblen
AI & Automation Solid

rseng-fairguard

Covers assessing research software against the 17 FAIR4RS principles with FAIRGuard (https://www.fairguard.org): compliance scores and levels (bronze to platinum), assessment profiles, quality gates for CI, .fairguard.yml configuration, per-indicator skips, and acting on findings. Use PROACTIVELY on research software projects - at repo intake, before releases, after adding publication metadata - and act on its findings. Also use when the user asks to check FAIR compliance, wants a FAIR score, report or badge level, wants a FAIR quality gate in CI, or mentions fairguard, FAIR4RS or .fairguard.yml. (FAIR concepts, principles and hand-guided improvement are rseng-fair-software; ML artifacts are rseng-fair-ml.)

14 Updated 4 days ago
fdiblen
AI & Automation Listed

fair-check

Audit manuscript and replication package against FAIR open-science principles.

55 Updated yesterday
scdenney