docs: __PSF Convolution__ section across simulator.py examples#124
Merged
Conversation
Normalize how PSF convolution / convolve_over_sample_size is documented across every simulator.py example. - imaging/simulator.py (the start-here reference) gains a __PSF Convolution__ docstring section, added to __Contents__, with the over-sample note written as docstring prose (galaxy terminology). - All other simulators with a real-space Gaussian PSF gain convolve_over_sample_size=1 as the first argument to from_gaussian(...), with no extra prose (users are assumed to have read the base simulator.py). Regenerated notebooks and the navigator catalogue. Mirrors autolens_workspace #257. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
Overview
Mirrors autolens_workspace #257/#258. Normalizes how PSF convolution /
convolve_over_sample_sizeis documented across everysimulator.pyexample.imaging/simulator.py(the start-here reference) gains a__PSF Convolution__docstring section, added to__Contents__, with an over-sample note as docstring prose (galaxy terminology).convolve_over_sample_size=1as the first argument tofrom_gaussian(...)— no extra prose.Notebooks and the navigator catalogue were regenerated from the scripts.
Scripts Changed
scripts/ellipse/simulator.pyscripts/guides/plot/simulator.pyscripts/imaging/features/extra_galaxies/simulator.pyscripts/imaging/features/multi_gaussian_expansion/simulator.pyscripts/imaging/features/operated_light_profile/simulator.pyscripts/imaging/features/pixelization/simulator.pyscripts/imaging/features/sky_background/simulator.pyscripts/imaging/simulator.pyscripts/multi/features/dataset_offsets/simulator.pyscripts/multi/features/same_wavelength/simulator.pyscripts/multi/features/wavelength_dependence/simulator.pyscripts/multi/simulator.pyRefs PyAutoLabs/autolens_workspace#257.