Skip to content

Commit e852eed

Browse files
egrace479hlapp
andauthored
Add versioning metadata: citation and Zenodo metadata files (#6)
* Add citation instructions for repo * Add metadata file for Zenodo sync * Add test for Zenodo metadata file * Improve description Co-authored-by: Hilmar Lapp <[email protected]> --------- Co-authored-by: Hilmar Lapp <[email protected]>
1 parent d494d65 commit e852eed

File tree

3 files changed

+88
-0
lines changed

3 files changed

+88
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Check zenodo metadata
2+
3+
on:
4+
push:
5+
paths:
6+
- '.zenodo.json'
7+
- '.github/workflows/validate-zenodo.yaml'
8+
9+
jobs:
10+
check-zenodo-metadata:
11+
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: actions/setup-node@v4
17+
with:
18+
node-version: '22'
19+
- name: Install dependencies
20+
run: npm install [email protected]
21+
- name: Check .zenodo.json file
22+
run: |
23+
npx zenodraft metadata validate .zenodo.json

.zenodo.json

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"creators": [
3+
{
4+
"name": "Campolongo, Elizabeth G.",
5+
"orcid": "https://orcid.org/0000-0003-0846-2413",
6+
"affiliation": "The Ohio State University"
7+
}
8+
],
9+
"description": "Catalog app for Imageomics data, models, and spaces hosted on Hugging Face. It was designed for improved discoverability and searchability of Imageomics products, and the content is updated in real-time through calls to the Hugging Face API.",
10+
"keywords": [
11+
"imageomics",
12+
"data",
13+
"models",
14+
"spaces",
15+
"Hugging Face",
16+
"APIs",
17+
"inventory",
18+
"catalog",
19+
"keyword search",
20+
"discoverability",
21+
"searchability"
22+
],
23+
"title": "Imageomics Catalog",
24+
"version": "1.0.0",
25+
"license": "MIT",
26+
"publication_date": "2025-11-13",
27+
"grants": [
28+
{
29+
"id": "021nxhr62::2118240"
30+
}
31+
]
32+
}

CITATION.cff

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
abstract: "Catalog app for Imageomics data, models, and spaces hosted on Hugging Face. It was designed for improved discoverability and searchability of Imageomics products, and the content is updated in real-time through calls to the Hugging Face API."
2+
authors:
3+
- family-names: "Campolongo"
4+
given-names: "Elizabeth G."
5+
orcid: "https://orcid.org/0000-0003-0846-2413"
6+
cff-version: 1.2.0
7+
date-released: "2025-11-13"
8+
identifiers:
9+
- description: "The GitHub release URL of tag v1.0.0."
10+
type: url
11+
value: "https://github.com/Imageomics/catalog/releases/tag/v1.0.0"
12+
- description: "The GitHub URL of the commit tagged with v1.0.0."
13+
type: url
14+
value: "https://github.com/Imageomics/catalog/tree/<commit-hash>" # update on release
15+
keywords:
16+
- imageomics
17+
- data
18+
- models
19+
- spaces
20+
- "Hugging Face"
21+
- APIs
22+
- inventory
23+
- catalog
24+
- "keyword search"
25+
- discoverability
26+
- searchability
27+
license: MIT
28+
message: "If you use this software, please cite it as below."
29+
repository-code: "https://github.com/Imageomics/catalog"
30+
title: "Imageomics Catalog"
31+
version: "1.0.0"
32+
# doi: add version-agnostic DOI from Zenodo on release
33+
type: software

0 commit comments

Comments
 (0)