Skip to content
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

Downloading Mission-Specific Data with Astroquery #92

Merged
merged 6 commits into from
Jan 30, 2025

Conversation

snbianco
Copy link
Contributor

@snbianco snbianco commented Dec 19, 2024

A notebook detailing the workflow for searching datasets, retrieving data products, and downloading data products using astroquery.mast.MastMissions, a wrapper to the MAST Search API. These changes haven't been merged into Astroquery yet (why the tests are failing), so leaving as a draft for now.

@snbianco
Copy link
Contributor Author

Tagging @ttdu @astrojimig @dr-rodriguez @adrianlucy for visibility

@snbianco snbianco marked this pull request as ready for review January 24, 2025 22:06
@snbianco snbianco requested a review from ttdu as a code owner January 24, 2025 22:06
@snbianco
Copy link
Contributor Author

The Astroquery changes have been merged, so this is now ready for review!

@astrojimig
Copy link

astrojimig commented Jan 28, 2025

This looks great! A really nice overview of the new additions to the MissionsMast Class. I downloaded & ran it locally with no errors. This update is going to be so useful for users, and this notebook does a great job to highlight its features!

Just a few small notes:

  • Remember to update the table of contents file and the chapter readme with this new notebook too!
  • “Searching MAST using astroquery.mast notebook” -> consider using the html render instead of the GitHub link?
  • You might want to link the Outerspace API guide when you introduce the “MAST Search API”: https://outerspace.stsci.edu/display/MASTDOCS/Using+MAST+APIs (there’s also some pages on auth tokens there you could link later). I think it's slightly more user-friendly than the direct docs link, but it would be good to have both
  • “The following missions/products are available for search at time of writing” -> specify “as of Jan 2025” or similar?
  • “instantiate” - > initiate?
  • There are a few places in the markdown cells where you note exact numbers (..."There were 681 total results"..."19 HST datasets fall within our cone search."...). How future-proof are these numbers? If HST observes M1 again, the numbers in the notebook might be outdated. I like including them so the user can self-verify, but maybe an alternative could be changing the language to be more vague ("There are over 600 total results...") or including the date (as of Dec 2024, there are 681 total results...). I don't feel strongly about this either way, so do whatever you think it best!

@ttdu
Copy link
Collaborator

ttdu commented Jan 29, 2025

* There are a few places in the markdown cells where you note exact numbers (..."There were 681 total results"..."19 HST datasets fall within our cone search."...). How future-proof are these numbers? If HST observes M1 again, the numbers in the notebook might be outdated. I like including them so the user can self-verify, but maybe an alternative could be changing the language to be more vague ("There are over 600 total results...") or including the date (as of Dec 2024, there are 681 total results...). I don't feel strongly about this either way, so do whatever you think it best!

Chiming in to agree with Julie! I tend to use vague language (i.e. "over 600 results").

@snbianco
Copy link
Contributor Author

Thank you @astrojimig and @ttdu, this is great feedback! I'll make these changes sometime today and ping again.

@snbianco
Copy link
Contributor Author

Just pushed those changes! The only thing is that I didn't see anything about the MAST Search API on the Outerspace API guide; it only talks about the portal API. I think that the Swagger docs may be the only thing we have for the MAST Search API at the moment.

@snbianco snbianco merged commit bdcb3e3 into spacetelescope:main Jan 30, 2025
6 checks passed
@snbianco snbianco deleted the mast-search-downloads branch January 31, 2025 02:27
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.

3 participants