docs: surface datacube modeling and document 14 undocumented example folders - #482
Merged
Merged
Conversation
Datacube modeling shipped in May 2026 under scripts/interferometer/features/datacube/, but was effectively invisible: the parent features/README.md "Folders" list never gained a `datacube` entry, and nothing in the top-level dataset-type listings hinted that anything other than single-channel continuum data was supported. - interferometer/features/README.md: add the missing `datacube` bullet - interferometer/README.md: state that both continuum data and spectral-line cubes are supported, and point at features/datacube - scripts/README.md + root README.md: note cubes on the interferometer entry - llms.txt: add a datacube route to the "I want to…" routing list Notebook READMEs are the generator's copies of the scripts/ originals and are updated in step. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015zxc8vHNQ6FPqsRJaT8tGk
An audit comparing every scripts/**/README.md against the folders actually beside it found 14 subfolders that no parent README mentioned at all — the same staleness that hid the datacube package. A reader browsing the folder listing had no way to learn these existed. - group/features: scaling_relation; advanced adds double_source_plane_lens and mass_stellar_dark - guides/results: aggregator, database - imaging/data_preparation: gui, manual - imaging/features/advanced: los_halos - interferometer/data_preparation: examples - interferometer/features: linear_light_profiles, multi_gaussian_expansion, scaling_relation - point_source/features: scaling_relation Also fixes a stale name: imaging/features/advanced/subhalo/README.md listed `detection`, but the folder is `detect`. Descriptions are taken from each folder's own README or script docstring rather than inferred from the folder name. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015zxc8vHNQ6FPqsRJaT8tGk
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.
Summary
Datacube modeling shipped in May 2026 under
scripts/interferometer/features/datacube/, but was effectively invisible: the parentfeatures/README.md"Folders" list never gained adatacubeentry, and nothing in the top-level dataset-type listings hinted that anything beyond single-channel continuum data was supported. The original requester's thread (PyAutoMind#18) sat open for three months after the feature it asked for had already landed.Auditing that one omission surfaced a broader instance of the same defect, fixed in the second commit.
Commit 1 — surface datacube modeling
scripts/interferometer/features/README.mddatacubebulletscripts/interferometer/README.mdfeatures/datacubescripts/README.md, rootREADME.mdllms.txtCommit 2 — the same defect, everywhere else
An audit comparing every
scripts/**/README.mdagainst the folders actually beside it found 14 subfolders that no parent README mentioned at all:group/features:scaling_relation;advancedaddsdouble_source_plane_lens,mass_stellar_darkguides/results:aggregator,databaseimaging/data_preparation:gui,manualimaging/features/advanced:los_halosinterferometer/data_preparation:examplesinterferometer/features:linear_light_profiles,multi_gaussian_expansion,scaling_relationpoint_source/features:scaling_relationAlso fixes a stale name:
imaging/features/advanced/subhalo/README.mdlisteddetection, but the folder isdetect.Every description is taken from that folder's own README or a script docstring — none inferred from the folder name.
Verification
check_navigatorpasses (path check + banner lint) — every new folder reference resolves.navigator.pybuildsllms-full.txt/workspace_index.jsonfrom script docstrings only, never from.md.llms.txtis hand-maintained and edited directly.scripts/originals (generate.pycopiesscripts/**/*.md) and are updated in step.Scope
Documentation only — no
.py, no notebooks, no datasets touched.Pairs with PyAutoLabs/PyAutoLens#694, which documents the same feature in the RTD overview.
Generated by Claude Code