Skip to content

Add citation metadata and instructions. - #28

Merged
roytsmart merged 1 commit into
mainfrom
feature/citation
Oct 1, 2026
Merged

roytsmart merged 1 commit into
mainfrom
feature/citation

Conversation

@roytsmart

Copy link
Copy Markdown
Contributor

This is the first step toward a citable software DOI for ctis. It's the same setup as sun-data/optika#247 and sun-data/named-arrays#253.

Changes

  • CITATION.cff (CFF 1.2.0). This turns on GitHub's "Cite this repository" button, and Zenodo will read the same metadata when it archives a release.
    • Authors: Roy T. Smart, Jacob D. Parker and Charles C. Kankelborg, with ORCIDs, following the copyright line in LICENSE.
    • Other fields: a one-paragraph abstract, which Zenodo uses as the record's description, plus the repository and docs URLs, the license, and keywords.
    • Left out on purpose: version and date-released, which would go stale with every release. Zenodo takes the version from the release tag.
  • README and docs: a new "Citation" section with a BibTeX example. It asks people to include the version they used and shows how to look it up with importlib.metadata.version("ctis").

Follow-up

Once this is merged, Zenodo's GitHub integration can be switched on for this repo. The next release will then be archived with a DOI, and a small follow-up PR will add the concept DOI here.

Testing

cffconvert --validate reports: "Citation metadata are valid according to schema version 1.2.0."

🤖 Generated with Claude Code

https://claude.ai/code/session_01N6zUsPoxW26srMeWormpe8

Add a `CITATION.cff` file, which enables the "Cite this repository" button
on GitHub, and a citation section to the README and the documentation.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01N6zUsPoxW26srMeWormpe8
@codecov

codecov Bot commented Oct 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (6b0f6a2) to head (316fa70).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #28   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           23        23           
  Lines          861       861           
=========================================
  Hits           861       861           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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