Repository navigation
docs: correct LBL W convention, LaTeX typo, NH3 note - #1186
Merged
Merged
Conversation
The prepared real relaxation matrix W is stored as W[to, from], not W[from, to], after the untransposition of the old Fortran copy. Update the developer and user line-shape docs to match the actual convention.
Correct the typo \Delta_nu_Z to the intended \Delta\nu_{Z} in
the line-by-line absorption math block.
The NH3 example never writes a plot file: it only calls plt.show(), which ARTS_HEADLESS suppresses under CTest. No test in tests/core/lbl uses savefig, so correct the documentation instead of the script. - tests/core/lbl/ecs_nh3.py: remove the saving claim from the docstring - doc/arts/user.lbl.rst: state that the window is suppressed by ARTS_HEADLESS rather than a PNG being written
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three documentation corrections in the line-by-line (LBL) docs, each bringing the
text in line with what the code actually does. No functional or API changes.
Changes
1. Relaxation matrix index convention —
doc/arts/dev.lbl.rst,doc/arts/user.lbl.rstThe prepared real relaxation matrix is stored as
W[to, from], the couplinginto line
tofrom linefrom, following the untransposition of the oldFortran copy. The docs still described it as
W[from, to]. Corrected in both thedeveloper array-preparation table and the
lbl.relaxation_matrix_profile()userdescription.
This now agrees with the implementation and the nanobind docstring:
src/core/lbl/lbl_lineshape_voigt_ecs_hadded.cppassignsW[to, from]relaxation_matrix_profiledocumentsW[i, j]as "the coupling into line ifrom line j", with the optical sum rule as the row closure
sum_j dipole[j] * W[i, j] == 02. LaTeX typo —
doc/arts/concept.absorption.lbl.rst\Delta_nu_Z->\Delta\nu_{Z}in the complex Voigt argumentz, so the Zeemanshift renders as a subscripted symbol instead of literal text.
3. NH3 example output claim —
doc/arts/user.lbl.rst,tests/core/lbl/ecs_nh3.pyThe docs stated the NH3 example "saves
ecs_nh3.pngin the current directory".It never does: the script only calls
plt.show(), whichARTS_HEADLESSsuppresses under CTest, and no test in
tests/core/lblwrites a figure file. Thedocumentation is corrected rather than adding a
savefigcall, matching thebehaviour of the other ECS tests.