Expand the README and the documentation landing page - #54
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #54 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 19 19
Lines 875 875
=========================================
Hits 875 875
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Both pages described the library in one sentence and showed a single example, loading a frame and displaying it, which left the reader with no idea that the package splits a frame into its four taps, measures and removes the bias, or models the sensor. Both pages now list the public API, and add a "Key concepts" section covering what a reader has to know to use the calibration steps: an image pairs pixel values with the header that describes them, the sensor is read out through four taps which each have their own bias, the blank and overscan columns are what measures that bias, and converting to electrons needs a gain that has to be measured. The landing page gains three examples: measuring and removing the per-tap bias, reading the header, and inspecting the sensor model. The README shows the same examples with their real output. The original example keeps its position, so the figure link already in the README still resolves. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
#55 made `dn_to_electrons` raise a `ValueError` naming the missing parameter, rather than silently producing an image whose outputs are `None`. Say so, since a reader who reaches for `.electrons` will now meet that error, and note that the gain differs from tap to tap. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
roytsmart
force-pushed
the
docs/readme-and-landing-page
branch
from
August 19, 2026 19:20
454dba2 to
5120386
Compare
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.
The README and the landing page
both described the library in one sentence and showed a single example, loading
a frame and displaying it. Nothing told the reader that the package splits a
frame into its four taps, measures and removes the bias, or models the sensor,
so the most useful parts of the API were reachable only by browsing the
autosummary.
Both pages
fits.open,SensorData,TapData,ImageHeader,Camera,TeledyneCCD230, andsamples.calibration steps make sense: an image pairs pixel values with the header
describing them, the sensor is read out through four taps that each have
their own amplifier and so their own bias, the 50 blank and 2 overscan
columns per tap are what measures that bias, and
.electronsneeds a gainthat has to be measured.
Landing page
Three new examples after the existing one: measuring the per-tap bias and
removing it, reading the header, and inspecting the sensor model. The corrected
frame is a much better picture of what this data is than the raw one, since
subtracting the ~3600 DN bias reveals the individual Fe55 X-ray events.
The original example keeps its position, so
_images/index_0_0.png, alreadylinked from the README, still resolves. The new figure is
index_2_0.png.Verification
Built the docs locally:
build succeeded, and the only warnings come fromexcluding the report notebooks, which this environment cannot build because
pandocis not installed. Every snippet was run to capture its real output,and all 15 API cross references in the new prose resolve to real pages.
One thing worth knowing
While exercising the API for these examples I found that
.electronsis brokenfor any image loaded through
msfc_ccd.fits.open:Camera.gaindefaults toNoneand, unlikeCamera.sensor, nothing resolvesit, so
dn_to_electronscomputesNone * aand the failure surfaces later infrom_taps. Passing an explicit gain works. That is a code fix rather than adocs fix, so it is not in this pull request; the documentation states that a
gain must be supplied, which is true either way.
🤖 Generated with Claude Code