Skip to content

chore(release): prepara snapshot citavel v6.0.0 para deposito Zenodo - #473

Merged
MarkSant merged 2 commits into
mainfrom
release/v6.0.0-zenodo-prep
Aug 15, 2026
Merged

chore(release): prepara snapshot citavel v6.0.0 para deposito Zenodo#473
MarkSant merged 2 commits into
mainfrom
release/v6.0.0-zenodo-prep

Conversation

@MarkSant

Copy link
Copy Markdown
Owner

Resumo

Prepara o repositório para a tag v6.0.0 e arquivamento permanente no Zenodo (P4/GigaScience, P5/Behavior Research Methods).

  • Corrige o logger closed-loop: fps/sampling_interval_ms em 5_ClosedLoop_*.csv agora gravam a taxa medida (FrameLedger.current_fps_measured()), não mais o valor configurado nas settings. O configurado fica em fps_configured/sampling_interval_ms_configured (colunas novas, append-only). Coberto por teste, incluindo o caso medido ≠ configurado.
  • Adiciona .zenodo.json (metadados completos para o release do Zenodo).
  • Atualiza CITATION.cff e pyproject.toml para 6.0.0; corrige badges de versão em README.md/README.pt-BR.md, docs/INDEX.md e __version__.
  • Nova seção ## [6.0.0] no CHANGELOG.md.

A remoção do material FAPESP não-arquivável (manuscritos inéditos, relatórios parciais, propostas, planilha financeira), Zebtrack.lnk e .mcp.json já chegou ao main via a PR #472 (efeito colateral de duas sessões do Claude Code operando no mesmo checkout — o conteúdo final está correto).

Test plan

  • poetry run pytest -q — 4235 passed, 4 skipped, 0 failed
  • poetry run ruff check . — limpo
  • poetry run mypy . (via hook de pre-push) — limpo
  • Teste do tarball (git archive + grep por material FAPESP/.lnk) — limpo
  • CITATION.cff validado via cffconvert --validate
  • .zenodo.json validado como JSON

🤖 Generated with Claude Code

MarkSant added 2 commits August 15, 2026 16:49
- corrige o logger closed-loop para gravar fps/sampling_interval_ms MEDIDOS
  (FrameLedger.current_fps_measured), preservando o valor configurado em
  fps_configured/sampling_interval_ms_configured (colunas novas, append-only)
- adiciona .zenodo.json com metadados completos (autores, ORCID, licenca,
  INPI, FAPESP)
- atualiza CITATION.cff e pyproject.toml para 6.0.0; corrige badges de
  versao em README.md/README.pt-BR.md, docs/INDEX.md e __version__
- nova secao [6.0.0] no CHANGELOG.md com o conteudo de RELEASE_NOTES_v6.0.0.md

Nota: a remocao dos manuscritos/relatorios/propostas/planilha FAPESP,
Zebtrack.lnk e .mcp.json (GIT_CLEANUP.md SS A1) ja chegou ao HEAD via a
PR #472 (merge dc7861b), que capturou essas mudancas de working tree
nao commitadas junto com um trabalho nao relacionado de otimizacao de
testes Tkinter -- efeito colateral de duas sessoes do Claude Code
operando no mesmo checkout. O conteudo final esta correto; so a
mensagem daquele commit nao descreve a remocao FAPESP.
Copilot AI lite review requested due to automatic review settings August 15, 2026 19:52
@MarkSant
MarkSant merged commit 7a356f9 into main Aug 15, 2026
6 checks passed
@MarkSant
MarkSant deleted the release/v6.0.0-zenodo-prep branch August 15, 2026 19:52

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Prepares the repository for the v6.0.0 archival/citable snapshot (Zenodo) while fixing a correctness issue in closed-loop latency logging so the exported fps reflects the measured capture rate (from FrameLedger) instead of the configured nominal FPS.

Changes:

  • Fix closed-loop latency logging to record measured fps/sampling_interval_ms, and append configured counterparts (fps_configured, sampling_interval_ms_configured) in an append-only manner.
  • Add/update release and archival metadata for Zenodo/citation and bump project version to 6.0.0 across the repo.
  • Extend test coverage to lock the measured-vs-configured FPS behavior and ensure CSV column order remains append-only.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
tests/core/test_closed_loop_latency.py Extends tests for append-only CSV columns and measured-vs-configured FPS behavior in closed-loop logs.
tests/core/recording/test_frame_ledger.py Adds tests for FrameLedger.current_fps_measured() correctness and regression coverage.
src/zebtrack/core/services/closed_loop_latency.py Appends new configured-rate columns and computes sampling intervals from measured vs configured FPS.
src/zebtrack/core/recording/frame_processing_pipeline.py Populates closed-loop context with measured FPS from the frame ledger plus configured FPS separately.
src/zebtrack/core/recording/frame_ledger.py Adds _fps_from_timestamps() helper and current_fps_measured() for in-session FPS measurement.
src/zebtrack/init.py Bumps __version__ to 6.0.0.
README.md Updates version badge and adjusts wording to reflect current release context (v6.0.0).
README.pt-BR.md Updates version badge and adjusts wording to reflect current release context (v6.0.0).
pyproject.toml Bumps Poetry package version to 6.0.0.
docs/reference/system_integration.md Documents measured vs configured FPS semantics and adds v6.0.0 column additions.
docs/INDEX.md Updates documentation index version to 6.0.0.
CITATION.cff Updates citation metadata for v6.0.0 and archival readiness.
CHANGELOG.md Adds a 6.0.0 release section describing the archival snapshot and the closed-loop FPS fix.
.zenodo.json Adds Zenodo deposition metadata for the v6.0.0 snapshot.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread CHANGELOG.md
Comment on lines +14 to +16
Citable snapshot archived on Zenodo, in support of the manuscripts describing the platform
(validation study) and the multi-method tracking benchmark. See `RELEASE_NOTES_v6.0.0.md` for
the release body.
Comment thread docs/INDEX.md
Comment on lines 3 to +4
**Last Updated:** February 2, 2026
**Version:** 4.0.0 (Diátaxis Corrected)
**Version:** 6.0.0 (Diátaxis Corrected)

| Date | Version | Changes |
| ---- | ------- | ------- |
| Aug 15, 2026 | v5.1 | § 5.6 closed-loop `fps` corrected to the rate measured from capture timestamps (`FrameLedger.current_fps_measured()`), replacing the configured value that had been logged as achieved; configured value kept in new `fps_configured` / `sampling_interval_ms_configured` columns (release v6.0.0 archival snapshot) |
@codecov

codecov Bot commented Aug 15, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 88.00000% with 3 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/zebtrack/core/services/closed_loop_latency.py 81.81% 2 Missing ⚠️
src/zebtrack/core/recording/frame_ledger.py 91.66% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

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.

2 participants