Hysen Labs
Open-source project
research-software-ecosystem/content avatar
research-software-ecosystem

content

A metadata commons to store research software metadata

48 stars34 forksHTMLCC-BY-4.0
DEEP OPEN-SOURCE ANALYSIS

Research software ecosystem content stores shared metadata

A metadata commons that aggregates research software descriptions from many sources into one repository for exchange between projects.

What the contents repository is for

This repository holds the metadata aggregated for the Research Software Ecosystem, which the README shortens to RSEc. Its purpose is to act as a central place for the exchange of software metadata across multiple projects. The README names several of those projects: bio.tools, Biocontainers, Bioconda, OpenEBench, Debian Med, and BIII.eu. The idea is that each of these sources describes research software in its own way, and this repository collects those descriptions so they can be shared and reused. The README frames the repository as a metadata commons, meaning a shared store rather than a tool or a service. Because the metadata comes from many upstream projects, the repository serves as a neutral meeting point where one tool's description can be pulled by another. The license is CC BY 4.0, which is a creative commons attribution license suited to shared data. For a researcher or a tool builder, the value is that software entries from several catalogs sit side by side in one place. The repository does not run analyses itself; it stores and organizes the descriptive records so other projects in the ecosystem can read them. The README lists bio.tools, Bioconda, Biocontainers, OpenEBench, Debian Med, and BIII.eu as the connected sources.

How the metadata is organized on disk

The README explains that all software metadata lives in the data folder of the repository. Each software package or tool gets its own distinct folder, and inside that folder are multiple files. Each file contains the metadata for that software as it comes from a specific resource, or as it has been reformatted into a specific format. So a single tool may appear as several files, one per source or per output format, all grouped under one folder. The README gives a worked example using the fastqc tool. Inside the fastqc folder there is fastqc.biotools.json, which is the metadata for the bio.tools entry and is pulled by the RSEc bot. There is bioconda_fastqc.yaml for the Bioconda package, also pulled by the RSEc bot. There is biocontainers.yaml for the Biocontainers image, pushed by the Biocontainers bot. There is fastqc.oeb.metrics.json for OpenEBench metrics, pulled by the RSEc bot. There is fastqc.debian.yaml for the Debian Med package, pulled by the RSEc bot. And there is fastqc.bioschemas.jsonld, which is converted from the bio.tools metadata by the RSEc bot. The fastqc example shows each upstream project contributing one named file inside a single tool folder, which makes the layout self describing. That naming scheme is the main documentation for the folder layout and needs no extra explanation beyond the file names themselves.

How the metadata flows between projects

The file names in the README reveal how data moves through the ecosystem. Several files are described as pulled by the RSEc bot, which means an automated process fetches them from an upstream source and writes them into the folder. The biocontainers.yaml file is described as pushed by the Biocontainers bot, which is the reverse direction: a source writes its record into this repository. The fastqc.bioschemas.jsonld file is converted from bio.tools metadata by the RSEc bot, showing that one format can be derived into another and stored alongside the original. This mix of pull, push, and conversion is how the commons stays in sync with the projects it serves. A tool maintainer can thus see, in one folder, what bio.tools says, what Bioconda packages, what container exists, what OpenEBench measured, and what Debian Med ships, plus a JSON LD view for semantic web use. The README's outline is the documentation for that structure. Because each file is named after its source or format, a reader can tell at a glance which project contributed a given record and whether it was fetched, sent, or generated. The mix of pull, push, and convert steps keeps the shared metadata in sync with each source.

Editorial conclusion

The repository is licensed under CC BY 4.0 and acts as a central exchange point for metadata from projects such as bio.tools, Bioconda, Biocontainers, OpenEBench, and Debian Med, with each tool stored in its own folder under the data directory.

DEEP OPEN-SOURCE ANALYSIS

Official sources

Community notes

Community notes