Skip to content

docs: RTD three-regime remainder — api regime notes, cookbook recipes, flagships - #654

Merged
Jammy2211 merged 1 commit into
mainfrom
claude/pyautolens-doc-reorganization-w6a1l5
Jul 26, 2026
Merged

docs: RTD three-regime remainder — api regime notes, cookbook recipes, flagships#654
Jammy2211 merged 1 commit into
mainfrom
claude/pyautolens-doc-reorganization-w6a1l5

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Completes the RTD leg of the three-regime documentation split (single-copy API reference with per-surface regime notes, per the plan in PyAutoMind docs_three_regime_restructure.md). Docs-only — no code changes.

  • overview_1_start_here.md: the regime enumerations now spell out the four-rung ladder (galaxy-scale, multi-galaxy, group-scale, cluster-scale).
  • overview_2_new_user_guide.md: the ladder cites flagship systems per rung (SDSS J1011+0143 / B1608+656; CSWA 19 / SL2S; HFF Abell 2744 — the system the workspace cluster start_here models).
  • api/mass.rst: Total section notes untruncated Isothermal/PowerLaw for galaxy/multi-galaxy vs tidally truncated dPIE members for group/cluster (sigma = Lenstool's sigma_LT vs b0 parameterizations named).
  • api/point.rst: point sources are also the standard source strategy at cluster scale (per-source redshifts, multi-plane).
  • api/galaxy.rst: new "Galaxy Catalogues (CSV)" section documenting galaxy_table_from_csv / galaxies_from_csv_tables / galaxy_af_models_from_csv_tables (previously absent from the API docs).
  • general/model_cookbook.md: new "Multi Galaxy, Group and Cluster Models" section — per-deflector loop recipe, shared-prior scaling-relation tie, cluster point-source framing, links to the four regime notebooks (all verified to exist).

Opus-reviewed; findings (nonexistent sigma_lt parameter name, centre-unpacking in cookbook snippets) fixed.

🤖 Generated with Claude Code

https://claude.ai/code/session_012Eacj9naBWSKrevsqnVJWR


Generated by Claude Code

…, flagships

Completes the RTD leg of the regime split (single-copy API reference with
per-surface regime notes, per the plan):

- overview_1_start_here.md: regime enumerations spell out the four-rung
  ladder (galaxy-scale, multi-galaxy, group-scale, cluster-scale).
- overview_2_new_user_guide.md: the ladder now cites flagship systems per
  rung (SDSS J1011+0143 / B1608+656; CSWA 19 / SL2S; HFF Abell 2744).
- api/mass.rst: Total section notes untruncated Isothermal/PowerLaw for
  galaxy/multi-galaxy vs tidally truncated dPIE members for group/cluster
  (sigma_lt vs b0 parameterizations named).
- api/point.rst: point sources are also the standard source strategy at
  cluster scale (per-source redshifts, multi-plane).
- api/galaxy.rst: new Galaxy Catalogues (CSV) section documenting
  galaxy_table_from_csv / galaxies_from_csv_tables /
  galaxy_af_models_from_csv_tables (previously absent from the API docs).
- general/model_cookbook.md: new Multi Galaxy, Group and Cluster Models
  section — per-deflector loop recipe, shared-prior scaling-relation tie,
  cluster point-source framing, links to the regime notebooks.

Co-Authored-By: Claude Fable 5 <[email protected]>
Claude-Session: https://claude.ai/code/session_012Eacj9naBWSKrevsqnVJWR
@Jammy2211
Jammy2211 merged commit 3ab490a into main Jul 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants