DOI and Citations Setup (Zenodo)¶

Make canvodpy properly citable with a permanent DOI for academic papers using Zenodo + CITATION.cff.

Zenodo¶

Zenodo is a research data repository operated by CERN.

How it works¶

1. Initial setup (once)¶

You link your GitHub repository to Zenodo: - Zenodo watches for new releases - No manual uploads needed

2. Every release¶

just release canvod-store=1.1.0 canvodpy=1.1.0   # release commit on release/v1.1.0: open a PR, merge it
# then, on the merged main:
just tag-release
git push origin v1.1.0   # on its own: it starts the draft release
git push origin canvod-store-v1.1.0

Only the canvodpy tag (v1.1.0) creates a GitHub release, so Zenodo archives one version per canvodpy release; package tags get none.

Zenodo takes the version and date of the record from CITATION.cff and .zenodo.json at the tag. just release writes canvodpy's version and the release date into both (and into codemeta.json), so the record carries the version of the release.

Automatic workflow: 1. GitHub creates release v0.1.0 2. Zenodo detects new release 3. Zenodo archives the release 4. Zenodo mints DOI: 10.5281/zenodo.XXXXX 5. Zenodo creates citation metadata

3. Users cite your work¶

Researchers can cite:

Bader, N. F. (2026). canvodpy: GNSS Vegetation Optical Depth Analysis (v0.1.0).
Zenodo. https://doi.org/10.5281/zenodo.XXXXX

A DOI for each version: - v0.1.0 \(\rightarrow\) DOI: 10.5281/zenodo.12345 - v0.2.0 \(\rightarrow\) DOI: 10.5281/zenodo.12346 - Concept DOI \(\rightarrow\) DOI: 10.5281/zenodo.12344 (always latest)

Step 1. Create CITATION.cff (done)¶

CITATION.cff enables the "Cite this repository" button on GitHub, exports to BibTeX/APA/EndNote, and provides metadata for Zenodo.

Step 2. Connect GitHub to Zenodo¶

2.1. Create a Zenodo account¶

1. Go to: https://zenodo.org
2. Click "Sign up"
3. Important: sign up with GitHub.
4. Click "Log in with GitHub"
5. This enables automatic integration

2.2. Enable the repository on Zenodo¶

1. After logging in, go to: https://zenodo.org/account/settings/github/
2. Find TUW-GEO/canvodpy in the list
3. Toggle ON the switch next to it
4. Zenodo now watches for releases.

2.3. Verify the connection¶

• Should see: "✓ Enabled" next to canvodpy
• Zenodo archives the next release

Step 3. Create the first release¶

Option A. Test with a beta release¶

git tag -a v0.1.0b2 -m "Test Zenodo DOI creation"
git push origin v0.1.0b2

• Zenodo creates DOI
• You can test the process safely

Option B. Production release¶

just release canvodpy=0.1.0 canvod-readers=0.1.0 ...   # open a PR, merge it
# then, on the merged main:
just tag-release
git push origin v0.1.0   # on its own: it starts the draft release
git push origin canvod-readers-v0.1.0 ...

• Creates the GitHub release; PyPI follows with gh workflow run publish_pypi.yml --ref v0.1.0
• Zenodo creates DOI
• This is the "real" first citable version

After the release¶

1. Go to: https://zenodo.org/account/settings/github/repository/TUW-GEO/canvodpy
2. You'll see your release listed
3. Click to view the DOI
4. Copy the DOI badge markdown

Example DOI badge:

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.12345.svg)](https://doi.org/10.5281/zenodo.12345)

Step 4. Add the DOI badge to the README¶

Add to README.md (after other badges):

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.XXXXX.svg)](https://doi.org/10.5281/zenodo.XXXXX)

Replace XXXXX with your actual Zenodo ID.

Tip: use the "concept DOI" (always points to latest version)

Step 5. Update the documentation¶

Add citation section to README.md:

## Citing canvodpy

If you use canvodpy in your research, please cite:

Bader, N. F. (2026). canvodpy: GNSS Vegetation Optical Depth Analysis (v0.1.0).
Zenodo. https://doi.org/10.5281/zenodo.XXXXX

BibTeX:
\`\`\`bibtex
@software{bader2026canvodpy,
  author       = {Bader, Nicolas François},
  title        = {canvodpy: GNSS Vegetation Optical Depth Analysis},
  year         = 2026,
  publisher    = {Zenodo},
  version      = {v0.1.0},
  doi          = {10.5281/zenodo.XXXXX},
  url          = {https://doi.org/10.5281/zenodo.XXXXX}
}
\`\`\`

How citations work¶

For researchers using the package¶

From GitHub: 1. Click "Cite this repository" (top right) 2. Choose format (APA, BibTeX, etc.) 3. Copy citation

From Zenodo: 1. Visit Zenodo DOI link 2. Click "Export" \(\rightarrow\) Choose format 3. Copy citation

For papers¶

Researchers cite specific versions:

Correct:

"VOD was calculated with canvodpy v0.1.0 (Bader, 2026)."

Reference:

Bader, N. F. (2026). canvodpy v0.1.0. Zenodo. https://doi.org/10.5281/zenodo.12345

Why version-specific? - Reproducibility: v0.1.0 code is archived forever - Transparency: readers know exactly what was used - FAIR principles: the exact version is findable

Concept DOI and version DOI¶

Concept DOI (10.5281/zenodo.12344): - Always points to latest version - Use for: general citations, badges

Version DOI (10.5281/zenodo.12345): - Points to specific version (v0.1.0) - Use for: research papers (reproducibility)

Benefits¶

Troubleshooting¶

Example¶

On GitHub¶

Cite button:

[Cite this repository ▼]
├── APA
├── BibTeX
└── More formats...

On Zenodo¶

Record page:

DOI: 10.5281/zenodo.12345
Title: canvodpy: GNSS Vegetation Optical Depth Analysis
Authors: Nicolas François Bader
Version: v0.1.0
Publication date: 2026-02-04
Resource type: Software
License: Apache-2.0

[Download] [Cite] [Share] [Export]

In papers¶

Methods section:

"VOD was calculated using canvodpy v0.1.0 (Bader, 2026), an open source Python package for GNSS-based vegetation analysis."

References:

Bader, N. F. (2026). canvodpy: GNSS Vegetation Optical Depth Analysis (v0.1.0). Zenodo. https://doi.org/10.5281/zenodo.12345

Additional metadata (optional)¶

.zenodo.json¶

For advanced metadata customization, create .zenodo.json:

{
  "title": "canvodpy: GNSS Vegetation Optical Depth Analysis",
  "description": "Python package for VOD calculation from GNSS SNR data",
  "creators": [
    {
      "name": "Bader, Nicolas François",
      "affiliation": "TU Wien",
      "orcid": "0000-0000-0000-0000"
    }
  ],
  "keywords": ["GNSS", "VOD", "vegetation", "remote sensing"],
  "license": "Apache-2.0",
  "communities": [
    {"identifier": "canvodpy"}
  ]
}

communities adds every archived release to the canVODpy community on Zenodo. canvodpy, canvodpy-extensions and canvodpy-test-data all set it.

Note: CITATION.cff is usually enough.

Resources¶

• Zenodo Homepage
• Zenodo GitHub Integration Guide
• CITATION.cff Format
• ORCID Registration
• FAIR Principles
• Making Software Citable

Checklist¶

• Get ORCID iD (if you don't have one)
• Update CITATION.cff with your ORCID
• Create Zenodo account (log in with GitHub)
• Enable canvodpy on Zenodo settings
• Create first release (test with beta or go production)
• Copy DOI badge to README
• Add citation section to README
• Update documentation with citation instructions

Questions? Check Zenodo help or ask in discussions.