Overview
Add first-class LaTeX-readable documentation to every mass profile class and its key methods (convergence_2d_from, potential_2d_from, deflections_yx_2d_from). Each docstring should contain: mathematical definition in LaTeX, source paper reference, parameter descriptions with physical units, and cross-references to related profiles. Also update docs/api/mass.rst for completeness. Phase 5 (final) of the mass profiles refactoring epic (#445).
Plan
- Add LaTeX docstrings to total mass profiles (Isothermal, PowerLaw, dPIE families) with Tessore 2015/2016 and Eliasdottir 2007 references
- Add LaTeX docstrings to dark matter profiles (NFW, gNFW, cNFW families) with Navarro+1996, Oguri 2021 references
- Add LaTeX docstrings to stellar profiles (Sersic, Gaussian, Chameleon) with Sersic 1963 references
- Add LaTeX docstrings to sheet/point profiles (ExternalShear, MassSheet, PointMass, SMBH)
- Document MGE decomposer (
mge.py) and CSE decomposer (cse.py) with Shajib 2019 and Oguri 2021 references
- Update
docs/api/mass.rst to include all missing profiles (NFW MCR/Scatter/Virial variants, ExternalPotential, SMBH*, dPIEPotential, GaussianGradient)
Detailed plan
Affected Repositories
Work Classification
Library
Suggested branch: feature/mass-profiles-docs
Worktree root: ~/Code/PyAutoLabs-wt/mass-profiles-docs/
Key Files
- All files under
autogalaxy/profiles/mass/ (docstring additions)
docs/api/mass.rst — completeness update
Original Prompt
Click to expand
Add first-class LaTeX-readable documentation to all mass profile functions. Every class and key method gets a docstring with mathematical definition, paper references, parameter units, and cross-references.
Overview
Add first-class LaTeX-readable documentation to every mass profile class and its key methods (
convergence_2d_from,potential_2d_from,deflections_yx_2d_from). Each docstring should contain: mathematical definition in LaTeX, source paper reference, parameter descriptions with physical units, and cross-references to related profiles. Also updatedocs/api/mass.rstfor completeness. Phase 5 (final) of the mass profiles refactoring epic (#445).Plan
mge.py) and CSE decomposer (cse.py) with Shajib 2019 and Oguri 2021 referencesdocs/api/mass.rstto include all missing profiles (NFW MCR/Scatter/Virial variants, ExternalPotential, SMBH*, dPIEPotential, GaussianGradient)Detailed plan
Affected Repositories
Work Classification
Library
Suggested branch:
feature/mass-profiles-docsWorktree root:
~/Code/PyAutoLabs-wt/mass-profiles-docs/Key Files
autogalaxy/profiles/mass/(docstring additions)docs/api/mass.rst— completeness updateOriginal Prompt
Click to expand
Add first-class LaTeX-readable documentation to all mass profile functions. Every class and key method gets a docstring with mathematical definition, paper references, parameter units, and cross-references.