[논문 리뷰] Software publications with rich metadata: state of the art, automated workflows and HERMES concept

Stephan Druskat, Oliver Bertuch외 3명|arXiv (Cornell University)|2022. 01. 22.

Scientific Computing and Data Management인용 수 13

한 줄 요약

이 논문은 CI/CD 파이프라인을 활용하여 메타데이터를 수확, 검증 및 출판 저장소(예: Zenodo, Harvard Dataverse)에 기판하는 방식으로, rich하고 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.

연구 동기 및 목표

• rich한 메타데이터를 갖춘 연구 소프트웨어를 출판하기 위한 간편하고 자동화된 워크플로우의 부족을 해결한다.
• 표준화된 메타데이터 기판을 통해 FAIR 소프트웨어 원칙—찾기 쉬운, 접근 가능한, 상호운용성 있는, 재사용 가능한—을 실현한다.
• 연구자 및 소프트웨어 유지보수자들이 소프트웨어 인용 및 메타데이터 정제에 소요되는 수동 작업을 줄인다.
• 기금 제공 기관 및 기관 정책에서 소프트웨어를 제1의 연구 산출물로 삼는 데 부합함으로써 지속 가능한 소프트웨어 출판을 지원한다.
• 다양한 연구 소프트웨어 개발 환경에서의 도입을 촉진하기 위해 재사용 가능한 도구, 템플릿, 문서를 제공한다.

제안 방법

• CI/CD 플랫폼(예: GitHub Actions, GitLab CI)을 활용해 자동 메타데이터 수확 워크플로우를 트리거한다.
• 정적 소스(예: README, CITATION.cff, CodeMeta, 패키지 매니페스트) 및 버전 제어 시스템에서 메타데이터를 추출한다.
• 이질적인 메타데이터 소스를 일관되고 표준화된 세트로 통합하기 위해 메타데이터 검증 및 충돌 해결을 적용한다.
• 기판 이전에 대상 저장소 요구사항(예: Zenodo, InvenioRDM, Dataverse)에 최종 메타데이터 세트가 부합하는지 확인한다.
• 소프트웨어 아티팩트와 메타데이터를 자동으로 출판 저장소에 기판하여 지속 가능한 식별자(PID)를 반환한다.
• 워크플로우 기술 언어(예: CWL, Nextflow)를 통해 하이퍼바이저, 컨버터, 기판 유틸리티 등의 도구를 조합할 수 있도록 확장성을 지원한다.

실험 결과

연구 질문

• RQ1 다양한 소스 저장소에서 rich한 메타데이터를 갖춘 연구 소프트웨어 출판을 자동화된 워크플로우로 어떻게 간소화할 수 있는가?
• RQ2 소프트웨어 출판에서 FAIR 준수를 확보하기 위해 가장 효과적인 메타데이터 포맷과 표준은 무엇인가?
• RQ3 메타데이터 검증을 어떻게 개선하여, VCS 기여자 목록을 저자 정보 메타데이터로 사용하는 등의 일반적인 함정을 피할 수 있는가?
• RQ4 추가적인 출력물(예: CodeMeta, Citation File Format)은 출판된 소프트웨어의 유용성과 재사용성을 어떻게 향상시킬 수 있는가?
• RQ5 워크플로우 조합 언어(예: CWL, Nextflow)는 자동 소프트웨어 출판 파이프라인의 모듈성 및 유지보수성 향상에 어느 정도 기여하는가?

주요 결과

• HERMES는 rich한 메타데이터를 갖춘 연구 소프트웨어를 CI/CD 기반으로 자동 출판할 수 있게 하여, 수동 정제 부담을 크게 줄였다.
• 프로젝트의 도구는 CITATION.cff, CodeMeta, 패키지 매니페스트 등 다양한 소스에서 자동 메타데이터 수확을 지원한다.
• 일관성과 신뢰성 확보를 위해 메타데이터 검증 및 충돌 해결이 핵심이며, 특히 VCS 기여자 데이터와 공식 저자 정보를 조율할 때 중요하다.
• InvenioRDM 및 Dataverse API를 통해 Zenodo 및 Harvard Dataverse와 같은 주요 출판 저장소에 기판을 지원한다.
• CodeMeta 및 Citation File Format과 같은 출력 형식, 워크플로우 템플릿, 메타데이터 매핑을 향상시키기 위해 커뮤니티 피드백을 적극적으로 수렴한다.
• 워크플로우 기술 언어(예: CWL, Nextflow)의 사용은 메타데이터 처리 및 기판을 위한 모듈화되고, 조합 가능하며 확장 가능한 자동화 파이프라인을 가능하게 한다.