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

Abierto
  • ¿Algo no está bien?
#605 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
55/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
documentation, frontend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Jupyter Notebook
Estrellas
253
Forks
63
Merge medio
3 d 3 h
PR fusionados (30 d)
14

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de brickbots/PiFinder

Todos los issues de brickbots/PiFinder

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.