[论文解读] A Metadata-Based Ecosystem to Improve the FAIRness of Research Software

Patrick Kuckertz, Jan Göpfert+11 more|arXiv (Cornell University)|Jan 1, 2023

Scientific Computing and Data Management被引用 1

一句话总结

本文提出了DataDesc生态系统，这是一种基于元数据的框架，通过专用的元数据模式、基于OpenAPI的交换格式以及自动化工具链，实现对软件接口的机器可操作、详细描述，从而提升研究软件的FAIR性（可查找性、可访问性、互操作性、可重用性）。该方法通过以标准化、互操作的方式结构化接口数据模型，显著提高了软件的可重用性，其在FINE能源建模框架上的应用已得到验证。

ABSTRACT

The reuse of research software is central to research efficiency and academic exchange. The application of software enables researchers with varied backgrounds to reproduce, validate, and expand upon study findings. Furthermore, the analysis of open source code aids in the comprehension, comparison, and integration of approaches. Often, however, no further use occurs because relevant software cannot be found or is incompatible with existing research processes. This results in repetitive software development, which impedes the advancement of individual researchers and entire research communities. In this article, the DataDesc ecosystem is presented, an approach to describing data models of software interfaces with detailed and machine-actionable metadata. In addition to a specialized metadata schema, an exchange format and support tools for easy collection and the automated publishing of software documentation are introduced. This approach practically increases the FAIRness, i.e., findability, accessibility, interoperability, and so the reusability of research software, as well as effectively promotes its impact on research.

研究动机与目标

• 解决由于接口文档不充分且非机器可读而导致的研究软件可重用性低下的问题。
• 通过捕获软件数据模型和接口的详细、标准化元数据，提升互操作性。
• 通过自动化元数据提取和发布管道，减轻研究人员的文档编写负担。
• 通过标准化的交换格式，实现在不同平台间广泛传播软件元数据。
• 通过与FAIR原则和社区标准对齐，支持研究软件的长期可查找性和可重用性。

提出的方法

• 设计一种专用的元数据模式，用于捕获软件组件的数据模型结构、接口参数、取值范围和约束条件。
• 基于OpenAPI的分层结构构建交换格式，以确保机器可读性，并与现有API工具链无缝集成。
• 开发一套工具，直接从源代码（如Python注解）中提取元数据，实现元数据收集的自动化。
• 实施自动化发布管道，将元数据推送至软件仓库和发现平台。
• 重用并扩展现有模式（如CodeMeta），同时增加针对接口特定元数据的新元素。
• 通过正式的模式扩展，支持未来与外部库和过程依赖的集成。

实验结果

研究问题

• RQ1 如何以足够的技术细节描述研究软件接口，以实现机器可操作的发现和互操作？
• RQ2 需要何种元数据模式和交换格式，才能以标准化、可重用的方式表示软件数据模型？
• RQ3 如何实现元数据收集和发布的自动化，以减轻研究人员的文档负担？
• RQ4 在多大程度上可以扩展或替代现有软件文档和元数据格式，以支持软件的FAIR原则？
• RQ5 如何在元数据中正式表示接口参数与外部库之间的依赖关系？

主要发现

• DataDesc生态系统成功实现了对软件接口数据模型的机器可操作描述，显著提升了互操作性和可重用性。
• 基于OpenAPI的交换格式的集成，使得在自动化软件发现和工作流组合管道中实现无缝重用成为可能。
• 从源代码自动提取元数据显著降低了手动文档编写的工作量，并提高了数据一致性。
• 该框架在FINE能源建模框架上的验证表明其具有实际适用性，并揭示了当前元数据实践中的不足。
• 该方法实现了对Zenodo和软件仓库等平台的元数据发布的部分自动化，提升了长期可查找性。
• 针对过程依赖和外部库接口的未来扩展正在推进中，表明其具有广泛采用的强劲潜力。