(Not) another Registry. Release Notice: Data Model for Curated Software Platform Version 1.0

Autoren: Aleksander Marčić, Kilian Hensen, Stefan Büdenbender, Harald Lordick, Claes Neuefeind, Martin Sievers

Das Datenmodell einer im Rahmen von Text+ entwickelten kuratierten Softwareplattform für wissenschaftliche Editionen liegt nun in der Version 1.0 vor. Die Plattform verbessert die Sichtbarkeit von Software (und ihren Autor:innen), die bei der Arbeit mit wissenschaftlichen Editionen verwendet werden. Mit der Plattform verknüpfen sich für die Community außerdem folgende Ziele:

  • Sie bietet ein kuratiertes Set von Tools und Software für die Arbeit an und mit Editionen.
  • Sie stellt Metadaten zu verwendeter Software bereit, die für die im Aufbau befindliche Registry für Editionen benötigt werden.
  • Sie dient als Knotenpunkt in der weiteren Vernetzung von softwarebezogenen Ressourcen wie Tutorials, Lehrmaterialien und Workflows innerhalb von Text+.
  • Sie wird in das Angebot von Text+ eingebunden, wie z.B. das zukünftige Webportal und das Beratungsangebot rund um den Text+ Helpdesk.
  • Die kuratierten Daten können in die weitere Infrastruktur der NFDI und darüber hinaus integriert werden (z.B. NFDI4Culture Registry und SSH Open Marketplace, EOSC Marketplace, DNB).
Symbolbild Werkzeuge

Vorgehen bei der Modellierung

Zunächst haben wir uns im Sinne einer Landscape Analysis eine Übersicht über vorhandene Kataloge, Registries und Marketplaces verschafft. Dabei ist als Desiderat aufgefallen, dass Nutzer:innen nicht ohne weiteres abschätzen können, wie aktuell Software und Metadaten sind, und ob das betreffende Verzeichnis weiter betrieben und der Datenstand aktuell gehalten wird. Meist bleiben Verzeichnisse auf dem Stand, zu dem die Finanzierung des jeweiligen Projektes endete. Aktualisierungen, neue Software und Änderungen in den Metadaten können daher oftmals nicht mehr berücksichtigt werden.

Auf Basis dieser Analyse haben wir anschließend Anforderungen an Funktionalität und Modell für die kuratierte Softwareplattform formuliert. Dabei haben wir auch die Ergebnisse einer internen Umfrage zur Erfassung des Portfolios einbezogen, in der u.a. auch Tools abgefragt wurden, die innerhalb der Community zu spezifischen Zwecken verwendet werden. Als Ergebnis daraus haben wir die folgenden wesentlichen Anforderungen identifiziert:

  • Interoperabilität mit der geplanten / im Aufbau befindlichen Registry für Editionen
  • Verwendung von Normdaten (GND, ORCID) und eines kontrollierten Vokabulars (z.B. ein Editionsphasenmodell), über das sich Beziehungen zu Lehr- und Lernmaterialien, Editionen etc. herstellen lassen
  • Geringe Anzahl an Pflichtfeldern
  • Unterscheidung von dynamischen (z.B. Commit Activity, versionierte Zitationsvorgabe) und statischen Werten (z.B. Name, Beschreibung)
  • Ein möglichst niedriger Pflegeaufwand der Datensätze
  • User Management für Beteiligungsmöglichkeiten (z.B. Vergabe von “Patenschaften“ für Datensätze)
  • Anzeige von unabhängigen Indikatoren für Entwicklungsstatus und Aktualität von Software und Metadaten
  • Einbindung von Qualitätsindikatoren (statt User Ratings oder Zertifikaten), z.B. in Form von Badges oder durch die Integration von Metriken beispielsweise aus Softwarehosting- und -entwicklungsplattformen wie GitHub, GitLab, etc..

Um Feedback zu unseren Überlegungen zum Datenmodell und zur technischen Umsetzung der kuratierten Softwareplattform einzuholen, haben wir diese in verschiedenen Kontexten vorgestellt und diskutiert. Beim Text+-Plenary im Herbst 2022 war das Datenmodell Teil der Posterpräsentation der Task Area Editions. Auf dem SSH Open Marketplace Workshop konnten wir die Möglichkeiten einer Zusammenarbeit direkt mit den Entwickler:innen diskutieren. Im Rahmen der Arbeitsgruppe „Research Software Engineering“ der NFDI-Sektion Common Infrastructures wurde im März 2023 ein Workshop von uns mitorganisiert und durchgeführt, auf dem ein Konzept für einen NFDI-Basisdienst für die Verzeichnung von Research Software erarbeitet wurde (der Antrag auf einen Basisdienst mit dem Titel “nfdi.software” befindet sich derzeit in der Begutachtungsphase). Darüber hinaus findet in der NFDI-Sektion ein Austausch mit den Arbeitsgruppen „RSE Software Qualität“ und „RSE Software Metadata“ statt.

Angetrieben von der Task Area Editions in Text+ werden Modell und Umsetzung fortlaufend mit den anderen Teams, die ebenfalls mit der Konzeption und Interoperabilität von Datenmodellen betraut sind, diskutiert und koordiniert. Außerdem haben wir die Arbeit an der (mittlerweile veröffentlichten) Registry for Tools and Services von NFDI4Culture in unsere Überlegungen zum Modell und zur Konzeption der Plattform einbezogen und kontinuierlich mitverfolgt.

Das Datenmodell in der vorliegenden Version 1.0 stellt die Ergebnisse unserer Überlegungen formalisiert dar. Mit Blick auf die Veröffentlichung der kuratierten Softwareplattform im Herbst 2023 ist dies ein wichtiger erster Schritt. Das Datenmodell dient zum einen als Grundlage für die Harmonisierung mit den verschiedenen Modellen innerhalb von Text+; zum anderen ergeben sich daraus konkrete Anforderungen an die Implementierung der Plattform. Letztere soll allerdings nicht von Grund auf neu geschehen, sondern auf bestehenden Open Source-Lösungen aufbauen. Insofern stellt unser Datenmodell zunächst eine Idealform da, die entsprechend der Rahmenbedingungen bei der Implementierung in eine existierende Umgebung integriert und weiter angepasst wird.

Bei der Recherche und Analyse nachnutzbarer bestehender Marketplace/Registry-Software spielen neben einer möglichst hohen Übereinstimmung mit unserem Datenmodell die Kriterien Benutzungsfreundlichkeit (Usability), Stabilität, aktives Entwickler:innen-Team, bestehende Community von Nutzenden, konkrete Einsatzfälle insbesondere im wissenschaftlichen Umfeld und nicht zuletzt die Anpassbarkeit und Wartbarkeit durch Text+ eine wesentliche Rolle.

Im Ergebnis zeigt sich das „Research Software Directory“ (RSD) als besonders geeigneter Kandidat. Mit dem Netherlands eScience Center und dem Helmholtz-Institut setzen gleich zwei große Wissenschaftsinstitutionen Instanzen von RSD erfolgreich ein und entwickeln deren Kernkomponenten weiter. Auch der oben genannte Basisdienst-Antrag „nfdi.software“ für die NFDI-weite Verzeichnung von Research Software nennt RSD explizit.

Weiterführende Informationen zur Arbeit am Datenmodell sowie das Datenmodell selbst liegen im Gitlab-Repository von Text+. Dort informieren wir auch über Beteiligungs- und Kontaktmöglichkeiten.

Symbolbild Softwarecode

Übersicht über das Datenmodell

Die folgende Tabelle listet die Felder des Datenmodells samt eines möglichen Mappings auf existierende Felder des RSD-Datenmodells auf. Jedes Feld hat einen bestimmten Wertebereich. Ein * kennzeichnet Pflichtfelder, ~ steht für eine ungefähre, bzw. nicht ganz passgenaue, Entsprechung im RSD-Datenmodell.

FeldWertRSDKommentar
id*Stringid
name*Stringbrand name
description*Stringdescription
categories*Strings~keywordshier muss RSD angepasst werden
keywords*Stringskeywords
version*String~concept doiRSD Versionierung nur für Zitation (über Zenodo)
sourceCodeURLSource code repository URL
availableAt*URL~getting started URL
softwareLicenseTypez.B. freeAcademicUse, monthly, etc~licenseRSD gibt konkrete Lizenzen an
usedInEditionsname, id, availableAt~projectshier muss RSD angepasst werden
alternativeslink auf andere Instanz von EditionSoftware~related toolshier muss angepasst werden, woher/wie RSD related tools ableitet
collaboratorsname, idscontributors
citationcffconcept doiumfassende Zitationsangaben über Zenodo
userDocumentationget started URL
technicalDetailstechnicalDocumentation, prerequisites, operationInterfacesin RSD nicht vorgesehen (aber möglich als Freitext unter description); einige Tech Details werden aus Repositories einbezogen
supportcoming soonfür das Verlinken von Tutorials, Workflows, etc. muss RSD angepasst werden
reviewsURLs~mentionsmentions sind nicht nur Reviews, sondern sollen Impact von Software für Forschung zeigen
approved*booleanpublished

Zitiervorschlag
Aleksander Marčić/Kilian Hensen/Stefan Büdenbender/Harald Lordick/Claes Neuefeind/Martin Sievers: Release Notice: Data Model for Curated Software Platform Version 1.0, in: Text+ Blog, 04.09.2023, https://textplus.hypotheses.org/6444.

Beitragsbild: “werkzeugkasten” by freegr, Inhaltslizenz via pixabay. Weitere Bilder: Gemeinfrei, via pexels.



Diesen Blogbeitrag zitieren
Text+ Mitglied (2023, 4. September). (Not) another Registry. Release Notice: Data Model for Curated Software Platform Version 1.0. Text+ Blog. Abgerufen am 13. Juni 2024, von https://doi.org/10.58079/uqh5

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.

Suche in OpenEdition Search

Sie werden weitergeleitet zur OpenEdition Search