-
-
Notifications
You must be signed in to change notification settings - Fork 428
Update MAST documentation #3487
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3487 +/- ##
=======================================
Coverage 71.73% 71.73%
=======================================
Files 235 235
Lines 20258 20258
=======================================
Hits 14533 14533
Misses 5725 5725 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bsipocz
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Overall it looks good, I only wonder if a few more examples could be unignored?
| ... | ||
| >>> coord = SkyCoord(189.49206, 62.20615, unit="deg") | ||
| >>> survey_list = Zcut.get_surveys(coordinates=coord) | ||
| >>> print(survey_list) # doctest: +IGNORE_OUTPUT |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why the ignore here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's possible that we add new surveys or change the footprints of current ones, so this output would change. In fact, I ran the code again and got 4 surveys back, so I'll update that.
docs/mast/mast_cut.rst
Outdated
| >>> hdulist = Tesscut.get_cutouts(objectname="TIC 32449963", sector=37) | ||
| >>> cutout_coord = SkyCoord(107.18696, -70.50919, unit="deg") | ||
| >>> hdulist = Tesscut.get_cutouts(coordinates=cutout_coord, sector=33) | ||
| >>> hdulist[0].info() # doctest: +IGNORE_OUTPUT |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why the ignore, do we expect this to change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, this shouldn't change. I'll remove!
| 2 APERTURE 1 ImageHDU 82 (5, 5) int32 | ||
| >>> coord = SkyCoord(135.1408, -5.1915, unit="deg") | ||
| >>> sector_table = Tesscut.get_sectors(coordinates=coord) | ||
| >>> print(sector_table) # doctest: +IGNORE_OUTPUT |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this expected to change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since TESS is still producing data, it is possible for the list of sectors to grow.
|
Thanks! |
Our documentation was in need of a refresh, so I spent some time updating the pages while things were slow for these past few weeks.
mast_catalog.rsthad minimal changes since we're going to be doing a major rewrite soon that will include documentation updates. I also didn't spend too much time onmast_missions.rstsince that was written more recently.