Uh oh!
There was an error while loading. Please reload this page.
Expand the README and the documentation landing page - #200
Merged
Conversation
The landing page had no installation instructions and no runnable example, so the first executable code a visitor met was inside an API docstring. The README feature list had fallen behind the one in the documentation, missing image simulation, the linear forward model, sensor simulation, glass materials, and the ruling profiles. The landing page gains an installation section and two worked examples: the transmissivity of an aluminum filter, which shows the L edge these instruments are designed around, and the effective quantum efficiency of a back-illuminated CCD compared against an ideal back surface. A complete system is linked rather than duplicated, since `SequentialSystem` already carries a worked Newtonian telescope. The README lists the same features as the documentation, links to the documentation, and adds a "Key concepts" section covering what differs most from Zemax: surfaces are placed in global coordinates, the field of view and entrance pupil are computed rather than specified, rulings are a property of a surface, and any parameter can be an array. Also adds a development section and fixes the spelling of "uncertainty". Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@## main #200 +/- ##
=======================================
Coverage 99.58% 99.58% =======================================
Files 118 118 Lines 6933 6933 =======================================
Hits 6904 6904 Misses 29 29
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:
|
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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 landing page had no
installation instructions and no runnable example, so the first executable code
a visitor met was inside an API docstring. The README's feature list had also
fallen behind the one in the documentation, missing image simulation, the
linear forward model, sensor simulation, glass materials, and the ruling
profiles.
Landing page
aluminum filter, which shows the L edge that solar EUV instruments are
designed around, and the effective quantum efficiency of a back-illuminated
CCD compared against an ideal back surface.
optika.systems.SequentialSystemrather than a duplicate of it.optikarather thanIntroduction.I did try adding a compact raytrace figure here, but an on-axis mirror plotted
in the z-x plane draws the incoming and reflected legs on top of each other,
which reads worse than no figure at all. That is why the section links to the
telescope example instead of shipping a lesser version of it.
README
are placed in global coordinates rather than relative to the previous
surface, the field of view and entrance pupil are computed rather than
specified, rulings are a property of a surface, and any parameter can be an
array (which is also how uncertainty propagates).
mypy, which this repository runs and its siblings do not.uncertainityis now spelled correctly.Verification
Built the docs locally: exit code 0, both new figures generated, and no
warnings referencing
index.rst. The only warnings in the build arepre-existing ones from the package's own docstrings (an
\Oescape sequence inthe depletion models, and astropy's note about
sqrton aQuantitysubclass).
Both examples were also run standalone before being added, at roughly 5 seconds
each, and both figures were inspected.
The new figures are
index_0_0.pngandindex_1_0.png. The README's existinggallery links point at docstring-generated images, so none of them are affected
by this change.
🤖 Generated with Claude Code