Correct the documented units of translated Kerr coefficients

Aperta Adatta ai principianti
  • Qualcosa non va?
#625 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
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
julia, python
Ambito
backend, documentation

Direzione di ricerca

Inizia dalla dichiarazione dei coefficienti in src/solprop/translate/responses.py nel commit indicato, quindi trova la documentazione Julia associata sulle risposte e i controlli della documentazione. Correggi le due unità documentate mantenendo invariati i valori dei coefficienti e i valori predefiniti della fisica. Il lavoro è completato quando entrambe le convenzioni di densità danno dimensioni di C/m^2 dopo la moltiplicazione per la densità e E^3, senza modifiche numeriche.

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

Descrizione

documentation priority: high

What happens

KerrCoefficients.coefficient is documented as epsilon_0 * chi3, but its units are listed as those of chi3 alone. The builder actually includes EPS0, so the implementation and dimensional description disagree.

Why it matters

Backend lowering must carry this coefficient unchanged. A reader following the stated units could apply a second vacuum-permittivity factor or misinterpret a number-density profile.

Reproduction

Read, not a numerical failure: at a6f30aba, src/solprop/translate/responses.py documents m^2/V^2 and m^5/V^2, while kerr_coefficients assigns EPS0 * response.chi3. Since epsilon_0 has units C/(V m), the coefficient has units C m/V^3 for dimensionless density and C m^4/V^3 for number density in m^-3. Multiplication by density and E^3 then gives polarisation in C/m^2.

Context

Found during the SEP 48 response port, #608 / #611. Coefficient declaration. The numerical builder is correct.

To do

  • Correct the two units in the translated coefficient's documentation.
  • Keep coefficient values and all physics defaults unchanged.
  • Check associated Julia response documentation and documentation checks.

Done when

The documented dimensions yield C/m^2 for both density conventions, with no numerical change.

Lingua principale
Python
Stelle
3
Fork
3
Merge medio
8h 28m
PR unite (30g)
176

Preparare l'ambiente

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 LupoLab/solprop

Tutte le issue di LupoLab/solprop

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.