Add Zenodo badge and CITATION.cff

[Copilot]

Overview

Adds Zenodo DOI badge (record 18937647) to the repository and introduces a CITATION.cff file to support formal software citation.

Changes

• README.md and docs/index.md: Added [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18937647.svg)](https://doi.org/10.5281/zenodo.18937647) badge alongside existing CI/PyPI badges.
• CITATION.cff (new): CFF 1.2.0 file with title, abstract, version, DOI (10.5281/zenodo.18937647), license, repository URL, keywords, and author metadata.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• zenodo.org
  • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Add Zenodo badges and Citations</issue_title>
<issue_description>### Expected Impact

Minor

Overview

Tasks:

• Update the repo to incorporate the Zenodo badge for voids: https://zenodo.org/records/18937647
• Add the badge to README.md and to the docs
• Add a CITATION.cff file</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Add Zenodo badges and Citations #44

---

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

[github-actions]

Coverage

• Overall line coverage on Ubuntu: 99.86%
• Diff coverage: n/a%
• Required diff coverage: 99%
• Result: ✅ passed

diff-cover output

-------------
Diff Coverage
Diff: origin/main...HEAD, staged and unstaged changes
-------------
No lines with coverage information in this diff.
-------------

[Copilot]

Pull request overview

Adds formal citation metadata and a Zenodo DOI badge so the project can be cited consistently in publications and the DOI is visible in both the repository and the documentation landing page.

Changes:

• Added Zenodo DOI badge to README.md and docs/index.md.
• Introduced a new CITATION.cff (CFF 1.2.0) with DOI, version, license, URLs, keywords, and author metadata.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
docs/index.md	Adds Zenodo DOI badge to the docs overview page alongside existing badges.
README.md	Adds Zenodo DOI badge to the repository README badge block.
CITATION.cff	Adds CFF citation metadata for the software (DOI/version/license/authors/etc.).

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

version and date-released are now additional release metadata that will need to be kept in sync on every version bump. The repo’s scripts/bump_version.py currently updates only pyproject.toml, pixi.toml, and src/voids/version.py, so these fields will drift and the citation metadata will become inaccurate. Consider either (a) extending the bump script to also update CITATION.cff (and similarly adjust date on release), or (b) removing these fields if you don’t plan to maintain them per-release.

Suggested change

	version: 0.1.6
	doi: 10.5281/zenodo.18937647
	date-released: "2025-01-01"
	doi: 10.5281/zenodo.18937647