Correct the documented units of translated Kerr coefficients
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- backend, documentation
Research direction
Start with the coefficient declaration in src/solprop/translate/responses.py at the referenced commit, then find the associated Julia response documentation and documentation checks. Correct the two documented units while preserving coefficient values and physics defaults. Done means both density conventions give dimensions of C/m^2 after multiplying by density and E^3, with no numerical change.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Python
- Stars
- 3
- Forks
- 3
- Avg merge
- 8h 28m
- Merged PRs (30d)
- 176
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from LupoLab/solprop
-
bug
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
documentation priority: medium
Difficulty 1/5 Under an hour Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
documentation priority: low
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
documentation good first issue priority: low
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
area: native priority: low testing
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
With emit_ontology_keys, one ontology key change is reported as two errors (keys and keys_digest)Possibly taken @rvandewater claimed this today. Openbug priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
iausathub/satchecker#286 ·
Maintainers usually reply within 1 day
-
bug test
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
OpenAssetIO/OpenAssetIO#1527 ·
-
automated endpoint-dead needs-curation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
almanac-data/climate-almanac#128 ·
Maintainers usually reply within 1 day