SQM: the !CAL badge flags the normal zero-touch state as uncalibrated

Aperta
  • Qualcosa non va?
#605 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation, frontend

Direzione di ricerca

Start with _is_calibrated() and the units-line badge in python/PiFinder/ui/sqm.py, then read docs/source/sqm.rst and docs/ax/sqm/CONTEXT.md for the intended wording. The issue identifies the files but leaves the final badge behavior open among removal, neutral relabeling, or no change. Done means the selected behavior accurately presents the normal zero-touch state and the user documentation matches it.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Problem

The SQM screen shows a !CAL marker whenever no per-device calibration file
exists (python/PiFinder/ui/sqm.py, _is_calibrated() / the units-line badge).

Uncalibrated is the normal, validated state. The zero-touch path is the one
the factory profiles are built for, and the headline archive accuracy in
docs/ax/sqm.md (bias −0.008 mag, MAE 0.061 mag across nine sweeps) was
measured with no calibration file present.

So the badge flags the expected case as a deficiency. docs/ax/sqm/CONTEXT.md
explicitly lists "Needs calibration" under Avoid these ambiguous phrases,
because factory profiles are the normal path. The screen's own badge says the
thing the glossary tells us not to say.

Since #544, the wizard's headline output matters even less than it used to: the
tracked black level supersedes the wizard-measured bias offset once its fit is
leased, leaving the dark-current rate as the wizard's only lasting contribution.

Options

  1. Show CAL only when a calibration file exists, and show nothing otherwise.
  2. Relabel the uncalibrated state to something neutral (e.g. FACT for factory
    profile) so both states read as valid.
  3. Leave it and rely on documentation.

Docs dependency

docs/source/sqm.rst currently explains the marker to users under
Calibration → When you need it:

The SQM screen shows a small !CAL marker when you have not run the
calibration wizard on your PiFinder. This is the normal state and it does not
mean anything is wrong. Once you run the wizard the marker changes to CAL.

If this badge is removed or relabelled, update that passage in
docs/source/sqm.rst in the same change. The screenshots on that page do not
show the badge, so no image re-capture is needed.

Lingua principale
Jupyter Notebook
Stelle
253
Fork
63
Merge medio
10h 48m
PR unite (30g)
9

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di brickbots/PiFinder

Tutte le issue di brickbots/PiFinder

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.