Add citation metadata and instructions.

[roytsmart]

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

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("optika").

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (9836969) to head (059f3d1).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #247   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          125       125           
  Lines         8828      8828           
=========================================
  Hits          8828      8828           

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.