Skip to content

Shorten the README and show the far-field bands in a figure - #186

Merged
kriboe90 merged 3 commits into
masterfrom
claude/readme-pedestal-figure
Nov 10, 2026
Merged

kriboe90 merged 3 commits into
masterfrom
claude/readme-pedestal-figure

Conversation

@kriboe90

@kriboe90 kriboe90 commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

Follow-up to #185 for the README.

  • Leaves out the sections on the analysed quantities and result files, on the reference images of the normalization, on the camera behind a window pane, on dense smoke and the read noise of the sensor (the unclipped intensities and the averaging of images) and on the features in validation.
  • Shortens the section on the far-field pedestal to the option, what step 3 does, the two quantities it writes and the two limits: the check with farbg_pedestal / sum_col_val and the tests in dark rooms only.
  • Adds doc/images/farfield_bands.svg. It shows the two bands beside a search area and how the zone around a neighbouring strip cuts one of them short. It has a light and a dark colour scheme that follow prefers-color-scheme, each on its own background, so it stays readable in both GitHub themes.

The README is also the description on PyPI, where a relative image path does not resolve, so it embeds the figure from master on raw.githubusercontent.com. The figure therefore shows in the README only after the merge. Preview from this branch:

Far-field bands of a search area

🤖 Generated with Claude Code

kriboe90 and others added 3 commits November 11, 2026 00:35
…out of the README

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…zation out of the README

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kriboe90
kriboe90 merged commit 0cc00cf into master Nov 10, 2026
4 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.

1 participant