Skip to content

Add .zenodo.json for software-archival DOI metadata - #26

Merged
jihoonkim888 merged 1 commit into
mainfrom
claude/zenodo-metadata
Jun 15, 2026
Merged

jihoonkim888 merged 1 commit into
mainfrom
claude/zenodo-metadata

Conversation

@jihoonkim888

Copy link
Copy Markdown
Owner

What

Add .zenodo.json so that, once the repo is connected to Zenodo, each GitHub Release is archived with a clean, consistent metadata record (and a citable DOI). Fields mirror CITATION.cff / pyproject.toml (authors, MIT, keywords) and link the arXiv paper.

Why

Reproducibility / archival — a Zenodo DOI permanently pins "these results were produced with PyTopo3D vX.Y.Z", independent of whether the GitHub repo still exists. This is not primarily a citation-count lever; the arXiv paper remains the main citation.

One-time manual step (owner) — required for any of this to take effect

.zenodo.json alone does nothing until the repo is linked to Zenodo:

  1. Sign in to https://zenodo.org with the jihoonkim888 GitHub account (authorize Zenodo's GitHub app).
  2. On https://zenodo.org/account/settings/github/ , flip the PyTopo3D repository toggle to On.
  3. Create the next GitHub Release — Zenodo archives it and mints a DOI. (Past releases are not auto-archived; only releases made after the toggle is on.)
  4. Zenodo issues two DOIs: a version DOI (this release) and a concept DOI (always resolves to the latest). Use the concept DOI for a README/CITATION badge.

Follow-up (me)

Once you have the concept DOI, paste it and I'll add the Zenodo DOI badge to the README and a doi: field to CITATION.cff.

🤖 Generated with Claude Code

Once the repo is connected to Zenodo, each GitHub Release is archived and gets a
citable DOI; Zenodo reads .zenodo.json to populate that record. This mirrors
CITATION.cff / pyproject (authors, MIT, keywords) and links the arXiv paper, so
the archived record stays consistent. Connecting the repo to Zenodo is a one-time
manual owner step (OAuth) — see the PR description.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@jihoonkim888
jihoonkim888 merged commit 8ae19a1 into main Jun 15, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant