Skip to content

docs: correct LBL W convention, LaTeX typo, NH3 note - #1186

Merged
riclarsson merged 3 commits into
atmtools:mainfrom
olemke:fix-docs
Oct 9, 2026
Merged

riclarsson merged 3 commits into
atmtools:mainfrom
olemke:fix-docs

Conversation

@olemke

@olemke olemke commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

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.rst

The prepared real relaxation matrix is stored as W[to, from], the coupling
into line to from line from, following the untransposition of the old
Fortran copy. The docs still described it as W[from, to]. Corrected in both the
developer array-preparation table and the lbl.relaxation_matrix_profile() user
description.

This now agrees with the implementation and the nanobind docstring:

  • src/core/lbl/lbl_lineshape_voigt_ecs_hadded.cpp assigns W[to, from]
  • relaxation_matrix_profile documents W[i, j] as "the coupling into line i
    from line j", with the optical sum rule as the row closure
    sum_j dipole[j] * W[i, j] == 0

2. LaTeX typo — doc/arts/concept.absorption.lbl.rst

\Delta_nu_Z -> \Delta\nu_{Z} in the complex Voigt argument z, so the Zeeman
shift renders as a subscripted symbol instead of literal text.

3. NH3 example output claim — doc/arts/user.lbl.rst, tests/core/lbl/ecs_nh3.py

The docs stated the NH3 example "saves ecs_nh3.png in the current directory".
It never does: the script only calls plt.show(), which ARTS_HEADLESS
suppresses under CTest, and no test in tests/core/lbl writes a figure file. The
documentation is corrected rather than adding a savefig call, matching the
behaviour of the other ECS tests.

olemke added 3 commits October 7, 2026 12:33
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
@olemke olemke changed the title docs: fix LBL relaxation-matrix convention, LaTeX typo, and trim OEM note docs: correct LBL W convention, LaTeX typo, NH3 note Oct 7, 2026
@riclarsson
riclarsson merged commit fe540dc into atmtools:main Oct 9, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants