Skip to content

docs: flesh out 'Other' feature stubs in start_here + features docs #442

Description

@Jammy2211

Overview

The __Other:__ section closing autolens_workspace/start_here.py is an unfinished stub — four bare bullets (mass models, SLaM, dark matter subhalos, graphical models) where every other feature gets a full illustrated section. The same stub is duplicated in PyAutoLens/docs/overview/overview_3_features.md, and the autogalaxy siblings carry the equivalent stub. This task fleshes the stubs out into full feature sections in the established format, adding weak lensing for autolens and covering graphical models only for autogalaxy.

Plan

  • Replace the __Other:__ stub in autolens_workspace/start_here.py with five full sections: Mass Models, Automated Pipelines / SLaM, Dark Matter Subhalos, Graphical Models, Weak Lensing — each with a science description, paper link where apt, and a Checkout ... pointer to a verified workspace script.
  • Mirror the same five sections over the ## Other stub in PyAutoLens/docs/overview/overview_3_features.md.
  • Replace the autogalaxy stubs (autogalaxy_workspace/start_here.py, PyAutoGalaxy/docs/overview/overview_3_features.md) with a Graphical Models section only; the "Automated pipelines / database tools" bullet is dropped per the request.
  • Regenerate notebooks for both workspaces, smoke-validate the touched start_here.py entries, then ship: two workspace PRs (ship_workspace) and two docs-only library PRs (ship_library).
Detailed implementation plan

Affected Repositories

  • autolens_workspace (primary)
  • autogalaxy_workspace
  • PyAutoLens (docs-only: docs/overview/overview_3_features.md)
  • PyAutoGalaxy (docs-only: docs/overview/overview_3_features.md)

Branch Survey

Repository Current Branch Dirty?
./autolens_workspace main clean
./autogalaxy_workspace main clean
./PyAutoLens main clean (claimed by 2 in-flight source tasks; zero file overlap with this docs-only edit — approved to run in parallel)
./PyAutoGalaxy main clean

Suggested branch: feature/start-here-other-feature-sections

Implementation Steps

  1. autolens_workspace/start_here.py (stub at ~line 592): replace __Other:__ with five sections matching the sibling format (__Heading__, prose, paper URL, Checkout ...):
    • Mass Models — beyond isothermal: power-law, decomposed stellar+dark, multipoles (m=1/3/4). Pointers: scripts/imaging/features/advanced/mass_stellar_dark/, scripts/guides/profiles/mass.py. Cite the Amvrosiadis mass-model/multipole paper (the 2024 ellipse-fitting paper 2407.12983 is already cited in the Ellipse Fitting section — confirm the intended arXiv link during writing).
    • Automated Pipelines / SLaM — non-linear search chaining and the Source, Light and Mass pipelines. Pointer: scripts/guides/modeling/slam_start_here.py.
    • Dark Matter Subhalos — detection + sensitivity mapping. Pointers: scripts/imaging/features/advanced/subhalo/detect/start_here.py, scripts/imaging/features/advanced/subhalo/sensitivity/start_here.py.
    • Graphical Models — joint sample fits with shared parameters (H0 time-delay example) and hierarchical parent distributions. Pointers: scripts/guides/modeling/advanced/graphical.py, hierarchical.py.
    • Weak Lensing — the scripts/weak/ package (Abell 2744 real-catalogue quickstart). Pointer: scripts/weak/start_here.py.
  2. PyAutoLens/docs/overview/overview_3_features.md: replace ## Other (line 227) with the same five sections in ## heading format.
  3. autogalaxy_workspace/start_here.py (stub at ~line 482) and PyAutoGalaxy/docs/overview/overview_3_features.md (line 156): replace stubs with a Graphical Models section framed for galaxy-structure samples; pointer to autofit_workspace/*/features/graphical_models.py (no autogalaxy-local graphical script exists; cross-workspace pointers have precedent in these files).
  4. Targeted edits only (no whole-file writes); run scripts/check_sizes.sh in the workspaces before committing.
  5. Regenerate notebooks (PyAutoHands generate.py, project keys autolens / autogalaxy, repo root as CWD).
  6. Smoke-run the touched start_here entries; docstring-only changes so expected trivially green.
  7. Ship: ship_workspace for the two workspaces; ship_library for the two docs-only library PRs.

Key Files

  • autolens_workspace/start_here.py — main stub replacement (five sections)
  • PyAutoLens/docs/overview/overview_3_features.md — docs mirror (five sections)
  • autogalaxy_workspace/start_here.py — graphical-models-only section
  • PyAutoGalaxy/docs/overview/overview_3_features.md — docs mirror (graphical only)

Notes

  • start_here.py prose is narrative tutorial content → written in the judgment tier, not delegated.
  • Worktree root: ~/Code/PyAutoLabs-wt/start-here-other-feature-sections/

Original Prompt

Click to expand starting prompt

start_here.py in autolens workspace neds in:

Other:

  • mass models (aris paper)
  • Automated pipelines / SLaM.
  • Dark matter subhalos.
  • Graphical models.
    Presumably this is missing from the features part of docs too.

Can you flesh this out for autolens, e.g. include the docs and wahtnot for mass models, slam, dark subhalos, graphical AND weak lensing, just graphical for galaxy.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions