QuantEcon / QuantEcon/QuantEcon.py

MAINT: Archive releases on Zenodo and point CITATION.cff at the concept DOI

Open
#960 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

maintenance
Dominant language
Python
Stars
2.4k
Forks
2.3k
Avg merge
3d 3h
Merged PRs (30d)
3

Description

Problem

CITATION.cff gives 10.5281/zenodo.10345102 as the software DOI. DataCite records that DOI as the archive of v0.7.1, issued 2023-12-11, and it is the archive DOI that JOSS recorded for the paper. Its concept DOI, 10.5281/zenodo.10345101, has exactly one version under it, so Zenodo has archived nothing since v0.7.1. Nine releases have shipped since then (v0.8.0 through v0.11.4) and none of them has a citable DOI. The file also carries no version or date-released.

The preferred-citation block (the JOSS article, 10.21105/joss.05585) is correct and matches the README entry after #864. This issue is only about the software DOI and the release process behind it.

Proposed change
  1. Enable the GitHub–Zenodo integration for this repository so every GitHub release is archived automatically as a new version under concept 10.5281/zenodo.10345101. This is a one-time setting that needs an organisation admin with a Zenodo login.
  2. Change the top-level doi in CITATION.cff to the concept DOI, so it always resolves to the latest archived version rather than the December 2023 snapshot.
  3. Add version and date-released to CITATION.cff, and add the step "update version and date-released in CITATION.cff" to the release procedure in docs/source/contributing.rst, or automate it in the publish workflow.
  4. Optionally add repository-code, url and license, which GitHub's "Cite this repository" panel uses.
Acceptance criteria
  • A Zenodo version record exists for the next release, under concept 10.5281/zenodo.10345101
  • The top-level doi in CITATION.cff is the concept DOI, and version and date-released match the latest tag
  • The release procedure names the CITATION.cff update step

Related: #885 covers the docs toolchain; this is a follow-up from the #903 audit and the #864 review.

Facts verified against the DataCite API on 2026-09-10.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing CITATION.cff and the release procedure in docs/source/contributing.rst, then check the repository’s GitHub–Zenodo integration and concept DOI settings. Update the citation metadata and release instructions so the next release is archived under the concept DOI and its version and date match the latest tag; verify the next Zenodo version record.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.