coords: add comprehensive docstring to CIRS frame (fixes #18981)#19307
coords: add comprehensive docstring to CIRS frame (fixes #18981)#19307Omiii-215 wants to merge 4 commits intoastropy:mainfrom
Conversation
The CIRS class had only a one-line description with no explanation of what the frame physically represents. Add a full docstring covering: - What CIRS is (geocentric intermediate frame, IAU 2000/2006) - The Celestial Intermediate Pole (CIP) and its precession-nutation model - The Celestial Intermediate Origin (CIO) and why it replaces the equinox - The Earth Rotation Angle (ERA) and the CIRS → ITRS transformation - The relationship to GCRS (same pole, different RA origin) and the equation of the origins - Astropy's implementation via ERFA (IAU 2006/2000A models) - Reference to USNO Circular 179 Section 2.6 Closes astropy#18981
|
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
|
I'm not the best person to review this as I don't know the details of the frame (hence the desire for docs lol). |
|
Would @ayshih be interested? |
|
The change log has to be removed and pre-commit has to be made happy, but I want to make sure the content is actually valid. Thanks, all. |
|
@pllim Thank you The description has been cross-checked against the following primary sources:
|
Description
The CIRS class had only a one-line description with no explanation of what the frame physically represents. Add a full docstring covering:
fixes #18981