docs: add src/rtm README (radiative transfer stage)#84
Merged
Conversation
Document the rtm/ forward-pass stage for both the physics and the code: the Fourier/streams/layer-RT/orders decomposition, each module's role, the two source routes, Jacobians, and a Performance deep-dive on the dominant functions and where work is skipped.
…pseudo spherical correction
bout3fiddy
marked this pull request as ready for review
June 17, 2026 19:08
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: e7bf3f2c55
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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
1 participant
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.
Adds
src/rtm/README.md, continuing the per-stage documentation set(
src/,input/,setup/,optics/are already documented).What this documents
The
rtm/stage is the core of the forward model, so this README coversboth the physics and the code:
wavelength, and its aerosol-state derivatives when a retrieval asks.
discrete streams, per-layer reflection/transmission via doubling, and
successive orders of scattering.
solve.zig/controls.zig(routes),gauss_anglesattenuation(directions and the direct beam),phase_basis,layer_reflect_transmit+matrix_12x10+rows,scattering_orders,reflectance, andjacobian_states.Where the time goesdeep-dive on thedominant functions (layer R/T build, the order recurrence, attenuation
fill) and the gates that skip work when the physics is thin.
Scope
Documentation only — one new file, no code changes.
Draft for review of wording and physics accuracy.