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

Manual check that tutorial labels are correct, likely after soft launch #26

Open
eblur opened this issue Sep 7, 2021 · 3 comments
Open

Comments

@eblur
Copy link

eblur commented Sep 7, 2021

We should do a manual (visual) inspection that tutorials are labeled properly and take note of any potential missing labels before the soft launch.

I recommend fixing any wrong labels or cross-references before the soft launch.

I recommend that missing labels be addressed after the soft launch.

@eblur
Copy link
Author

eblur commented Sep 14, 2021

I discussed this with @jonathansick during our meeting today and it was noted that in order to update the content labels we will need to update the tutorials themselves. (Astropy Librarian pulls the labels from the keyword terms.) So this will likely need to happen after the soft launch. I updated the header.

Also needed: Look at description (from first paragraph of the summary section) and sometimes it doesn't work well. The summary can get cut off, formatted weirdly, or can have issue for tutorials that don't follow the standard structure.

I will use this issue to take notes on these needed changes.

@eblur eblur changed the title Manual check that tutorial labels are correct, before soft launch Manual check that tutorial labels are correct, likely after soft launch Sep 14, 2021
@eblur
Copy link
Author

eblur commented Sep 14, 2021

Label issues

  • There is a label under Tasks called "fits" -- this should be in all caps (FITS) because it is an acronym. Otherwise, people might click on lowercase "fits" when they are looking for tutorials on model fitting.
  • Same issue for "latex" -> "LaTeX" although it is less likely to be a source of confusion
  • Similar issue for "wcs" -> "WCS", is there a reason all the labels are lowercase?
  • Astronomical Coordinates 1 - "gaia" keyword term is missing from side search bar
  • Using scipy.integrate - Add "scipy" to the keywords (or use Astropy Librarian to draw this directly from the import commands)
  • Read in catalog information from a text file and plot some parameters - consider adding a keyword called "projections" because it shows how to plot coordinate information on a mollweide projection with matplotlib. I think there is another tutorial that does this?
  • Read in catalog information from a text file and plot some parameters - Some tutorials like this one use from astropy.io import ascii. How would Astropy Librarian read that as a keyword? Should it be listed as an "io" or "tables" subpackage? I note that the UVES tutorial lists "astropy.io" as a keyword term, but there is no "io" subpackage in the search list. So perhaps "Read in catalog information" just needs the "table" keyword.
  • Similar question for FITS files, how should we handle package labeling for from astropy.io import fits ?
  • Working with FITS-cubes - "data cubes", "spectral cubes", "reproject" and "contour plots" are all missing from the search terms at left
  • Searching major star catalogs - has the keyword term "SIMBAD", not represented in the search box. Do we want to keep it?
  • Modeling 2 - has the keyword "Vizier", not represented in the search box. Do we want to keep it?
  • Perhaps we could make the keyword "catalogs" to cover both? Where should it go (science domains)?
  • Note that the "observational astronomy" keyword can apply to the majority of the tutorials. Should we toss it? Otherwise, expand its use.
  • Analyzing interstellar reddening - uses astropy.visualization, add "visualization" to the keywords and list it under Astropy Packages

Description text issues

  • Synthetic images from simulated data - description text is cut off
  • Using scipy.integrate - "units" is listed twice under keywords
  • Analyzing interstellar reddening - remove "dust extinction" keyword because "extinction" is also listed (and represented in the side bar)

Description text: suggested modifications

  • Modeling 2 - the description text is sparse.
  • Working with FITS cubes - the description text is sparse.
  • Make a plot with both redshift and universe age axes using astropy.cosmology - description text is ample but cuts off with a colon. Is more information needed?
  • Viewing and manipulating FITS images - learning goals switches from bulleted text to a numbered list midway through

@kelle
Copy link
Member

kelle commented Sep 14, 2021

Here's the sheet I was using to keep track of the taxonomy. It's in the Keyword Table tab. Feel free to edit directly! https://docs.google.com/spreadsheets/d/1JmOF82Zmrs397wLwAmmL1rgDSsvP6Z4fLMr0hV5ZIb4/edit#gid=953884002

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

No branches or pull requests

2 participants