Skip to content

Update CITATION.cff and docs to cite the SciPy 2024 proceedings paper - #1567

Open
thewtex wants to merge 1 commit into
InsightSoftwareConsortium:mainfrom
thewtex:scipy-citation-cff
Open

Update CITATION.cff and docs to cite the SciPy 2024 proceedings paper#1567
thewtex wants to merge 1 commit into
InsightSoftwareConsortium:mainfrom
thewtex:scipy-citation-cff

Conversation

@thewtex

@thewtex thewtex commented Jul 22, 2026

Copy link
Copy Markdown
Member

Summary

Makes the ITK-Wasm SciPy 2024 proceedings paper (doi:10.25080/TCFJ5130) the canonical citation for the project, and corrects the paper's title and page numbers everywhere they appeared in the repo.

Closes #1308
Closes #1251

What changed

  • CITATION.cff — Added a preferred-citation block (type conference-paper) describing the SciPy 2024 paper: both authors with ORCIDs, the conference and publisher entities, pages, ISSN, and DOI. Updated message to ask users to cite both the paper and the software. This uses the credit-redirection pattern requested in Update CITATION.cff to use SciPy paper #1308, so GitHub's "Cite this repository" widget now surfaces the paper. The software's own root-level metadata is left unchanged.
  • docs/index.md, docs/cxx/installation.md — Corrected the existing paper citation (title + start page; see below).
  • README.md — Added a "Citation" section pointing at the paper; the README previously carried only the software Zenodo archive badge.

Why

Issues #1251 (update citations for the SciPy Conference Proceedings paper) and #1308 (update CITATION.cff to use the SciPy paper, via credit redirection) ask to make this newly published paper the project's citation of record.

Corrected metadata

The citations already present in the docs disagreed with the official DOI record on two points:

Was (docs) Now (registered record)
Title ITK-Wasm: High-Performance Spatial Analysis Across Programming Languages and Hardware Architectures ITK-Wasm: Universal spatial analysis and visualization
Pages 268–279 256–279

The previous title was the descriptive phrase from the paper's abstract rather than the registered title. All metadata here is sourced from the CrossRef/DOI record, cross-checked against the DOI BibTeX and the paper's ResearchGate entry, and consistent with the repository's own tagline (docs/index.md, docs/python/introduction.md).

Validation

CITATION.cff validates against CFF schema 1.2.0 using the tool named in #1308:

$ cffconvert --validate -i CITATION.cff
Citation metadata are valid according to schema version 1.2.0.

The software Zenodo DOI badges (README.md, docs/index.md) are intentionally left in place — they archive the software, which is a distinct DOI from the paper citation.

🤖 Generated with Claude Code

@thewtex thewtex changed the title Update citations to the SciPy 2024 proceedings paper Update CITATION.cff and docs to cite the SciPy 2024 proceedings paper Jul 22, 2026
@thewtex
thewtex force-pushed the scipy-citation-cff branch from 8f0b81e to fe15ab5 Compare July 22, 2026 17:51
Redirect citation credit to the ITK-Wasm SciPy 2024 proceedings paper
(doi:10.25080/TCFJ5130) and correct the paper metadata across the repo.

- CITATION.cff: add a `preferred-citation` block (type conference-paper)
  with both authors, conference and publisher entities, pages, ISSN, and
  DOI, so GitHub's "Cite this repository" surfaces the paper. Update
  `message` to ask users to cite both the paper and the software.
  Validates against CFF schema 1.2.0 (cffconvert).
- docs/index.md, docs/cxx/installation.md: fix the citation, which used a
  title taken from the abstract and an incorrect start page. Use the
  registered title "ITK-Wasm: Universal spatial analysis and
  visualization" and pages 256-279 (were 268-279).
- README.md: add a Citation section (previously only the software Zenodo
  archive badge was present).

Metadata sourced from the CrossRef/DOI record.

Closes InsightSoftwareConsortium#1308
Closes InsightSoftwareConsortium#1251

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@thewtex
thewtex force-pushed the scipy-citation-cff branch from fe15ab5 to 3c823b6 Compare July 23, 2026 16:36
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.

Update CITATION.cff to use SciPy paper Update citations for SciPy Conference Proceedings paper

1 participant