search

spacetelescope / drizzlepac

AstroDrizzle for HST images.
https://drizzlepac.readthedocs.io
BSD 3-Clause "New" or "Revised" License
50 stars 39 forks source link

Readthedocs misnumbers AstroDrizzle Steps #196

Closed samanthalh closed 5 years ago

samanthalh commented 5 years ago

The numbering of the Steps AstroDrizzle uses (copied below) needs to change. Instead of 1-8, it should be something like 0-7 so that it matches the step numbers in the AstroDrizzle GUI, the CFG file, all the other documentation on AstroDrizzle available, and the information that’s listed further on down that same page (copied: STEP 1: STATIC MASK).

_This process involves a number of steps, namely:

  1. Processing the input images and input parameters
  2. Creating a static mask
  3. Performing sky subtraction
  4. Drizzling onto separate output images
  5. Creating the median image
  6. Blotting the median image
  7. Identifying and flagging cosmic-rays
  8. Final combination_

As you can see, having the Static Mask step listed as both 1 AND 2 in different places on the same page is very confusing and should be fixed. Thank you!!

mcara commented 5 years ago

In my opinion, the list in https://github.com/spacetelescope/drizzlepac/blob/036364e3c2f554eabccea5f2942172cee6da4458/drizzlepac/astrodrizzle.py#L8 (I believe this is the list you are referring to) is an outline of general processing steps performed by astrodrizzle. Some of the "steps", such as "Processing the input images and input parameters" cannot be turned off and therefore do not have a corresponding "step" in GUI that is allowed to be turned off.

If this is a source of confusion, how about replacing this numbered list with a bulleted list? Would that make things less confusing?

CC: @stsci-hack

mcara commented 5 years ago

Solved via #198

samanthalh commented 5 years ago

Hey @mcara!

Thanks for removing those numbers. That fixed it once place but it is still showing a mismatch on the sidebar and the contents page, which as you can see in the attached image is very confusing. Can you please remove or change the numbering on the sidebar and contents page as well?

astrodrizzle_step_mismatch

Thanks again!! Samantha