Jammy2211 / PyAutoGalaxy

PyAutoGalaxy: Open-Source Multiwavelength Galaxy Structure & Morphology
https://pyautogalaxy.readthedocs.io/
MIT License
27 stars 13 forks source link

Jacks doc updates #125

Closed jhod0 closed 10 months ago

jhod0 commented 10 months ago

As discussed with @Jammy2211 and @qiuhan96 on slack , I am updating some minor things I noticed in the documentation. The first is the code to scale deflection angles between different planes.

I have also added some clarifying documentation to (g)NFW functions. Some of the docs were incorrect, the description of scale_radius seemed to be describing r_{200c} instead.

I think there is also a slight discrepancy between how different parts of the code are using NFW halo definitions. The functions on AbstractGNFW to convert to physical units (mass, concentration) were implicitly using the M_{200m} mass definition, and the functions in mcr_util.py were implicitly using M_{200c} instead.

This is not a big deal, it doesn't actually cause any problems, but could lead to some confusion. I am updating the docs in each to clarify what mass definition they are implicitly using.