[論文レビュー] Software publications with rich metadata: state of the art, automated workflows and HERMES concept

Stephan Druskat, Oliver Bertuch+3 more|arXiv (Cornell University)|Jan 22, 2022

Scientific Computing and Data Management被引用数 13

ひとこと要約

本論文では、CI/CDパイプラインを活用してメタデータを収集・検証・寄附する仕組みを活用し、Zenodo や Harvard Dataverse などの公開リポジトリに豊富な FAIR準拠メタデータを備えた研究ソフトウェアを自動で公開するワークフローである HERMES を提案する。このソリューションはメタデータ抽出、競合解決、標準化された寄附を統合しており、人的作業を顕著に削減し、ソフトウェアの引用可能性と持続可能性を向上させる。

ABSTRACT

To satisfy the principles of FAIR software, software sustainability and software citation, research software must be formally published. Publication repositories make this possible and provide published software versions with unique and persistent identifiers. However, software publication is still a tedious, mostly manual process. To streamline software publication, HERMES, a project funded by the Helmholtz Metadata Collaboration, develops automated workflows to publish research software with rich metadata. The tooling developed by the project utilizes continuous integration solutions to retrieve, collate, and process existing metadata in source repositories, and publish them on publication repositories, including checks against existing metadata requirements. To accompany the tooling and enable researchers to easily reuse it, the project also provides comprehensive documentation and templates for widely used CI solutions. In this paper, we outline the concept for these workflows, and describe how our solution advance the state of the art in research software publication.

研究の動機と目的

• 豊富なメタデータを備えた研究ソフトウェアを効率的かつ自動化されたワークフローで公開する仕組みの不足を解消すること。
• 標準化されたメタデータ公開を通じて、FAIR ソフトウェア原則（検索可能、利用可能、相互運用可能、再利用可能）を実現すること。
• 研究者やソフトウェアメンテナスのソフトウェア引用およびメタデータ管理における人的作業を削減すること。
• 資金提供機関や機関のポリシーに準拠し、ソフトウェアを第一級の研究出力として位置づける持続可能なソフトウェア公開を支援すること。
• 多様な研究ソフトウェア開発環境での採用を促進するため、再利用可能なツール、テンプレート、ドキュメントを提供すること。

提案手法

• CI/CD プラットフォーム（例：GitHub Actions、GitLab CI）を活用し、自動メタデータ収集ワークフローをトリガーする。
• 静的ソース（例：README、CITATION.cff、CodeMeta、パッケージマニフェスト）およびバージョン管理システムからメタデータを抽出する。
• メタデータ検証および競合解決を実施し、多様なメタデータソースを一貫性があり標準化されたセットに統合する。
• 寄附対象のリポジトリ要件（例：Zenodo、InvenioRDM、Dataverse）に適合するか、最終的なメタデータセットを検証する。
• ソフトウェアアーティファクトおよびメタデータを自動的に公開リポジトリに寄附し、恒久的識別子（PID）を返却する。
• ワークフローデスクリプション言語（例：CWL、Nextflow）を活用し、ハーベスティングツール、コンバータ、寄附ユーティリティなどを組み合わせて拡張性を確保する。

実験結果

リサーチクエスチョン

• RQ1 多様なソースリポジトリにおいて、豊富なメタデータを備えた研究ソフトウェアの公開を自動化ワークフローがどのように簡素化できるか。
• RQ2 ソフトウェア公開における FAIR準拠を確保するために、最も効果的なメタデータフォーマットおよび標準は何か。
• RQ3 VCSのコントリビューターリストを著者情報メタデータとして使用するといった一般的な落とし穴を避けるために、メタデータ検証をどのように改善できるか。
• RQ4 CodeMeta や Citation File Format などの追加出力形式は、公開されたソフトウェアの有用性および再利用性をどのように向上させるか。
• RQ5 ワークフロー構成言語（例：CWL、Nextflow）を用いることで、自動ソフトウェア公開パイプラインのモularity および保守性はどの程度向上できるか。

主な発見

• HERMES は、豊富なメタデータを備えた研究ソフトウェアの CI/CD ベースの自動公開を可能にし、人的なメタデータ管理作業を顕著に削減する。
• 本プロジェクトのツールキットは、CITATION.cff、CodeMeta、パッケージマニフェストなど、複数のソースからの自動メタデータ収集をサポートする。
• メタデータ検証および競合解決は、特に VCS コントリビューターデータと公式著者情報の整合性を保つために、一貫性と信頼性を確保するために不可欠である。
• InvenioRDM および Dataverse API を介して、Zenodo や Harvard Dataverse などの主要な公開リポジトリへの寄附をサポートする。
• CodeMeta や Citation File Format などのメタデータマッピング、ワークフローテンプレート、出力形式の改善のため、コミュニティからのフィードバックを積極的に収集している。
• ワークフローデスクリプション言語（例：CWL、Nextflow）の使用により、メタデータ処理および寄附のためのモジュラーで組み合わせ可能かつ拡張可能な自動化パイプラインを実現している。