spacetelescope / wfc3tools

Python tools for HST WFC3 data calibration and analysis
https://wfc3tools.readthedocs.io/en/latest/
Other
6 stars 19 forks source link

Made a variety of updates and corrections to the calwf3 documentation #68

Closed mdlpstsci closed 1 year ago

mdlpstsci commented 2 years ago

Modified/updated a number of items in the calwf3.rst file only. This means the text has been updated up to and including the Using CRDS to Update Your Reference Files section. I tried to delineate and clarify the discussion of the underlying C calwf3 code vs the Python wrapper module.

Discussion of the components (e.g., wf3rej) of calwf3 still needs to be updated.

FDauphin commented 1 year ago

In addition, what files can and cannot be accepted need to be explicitly stated either in the subroutine docs or on this page

mdlpstsci commented 1 year ago

The sub-components of the CALWF3 pipeline are documented separately from this ticket. Done thus far are PR#69 and PR#71.

mdlpstsci commented 1 year ago

Aside from corrections to what is already written, there will be no new commits to this ticket as we want to avoid "documentation creep" and never get this ticket out the door. New topics should be covered by new tickets.

FDauphin commented 1 year ago

I am a little confused. If the comments were addressed, but not committed to the PR, doesn't that mean those changes won't be incorporated in the merge?

mdlpstsci commented 1 year ago

Indeed, I have been so busy I forgot to push the changes! I will make the two changes for the bad links, and push the new docs.

mdlpstsci commented 1 year ago

@FDauphin All of the updates have actually been pushed now!

mdlpstsci commented 1 year ago

For some reason I could not add any response to the last two comments, so here they are:

FDauphin commented 1 year ago

For some reason I could not add any response to the last two comments, so here they are:

  • Added the updated hyperlinks, and
  • Wrote Varun regarding the computation for photfnu. I think these equations are in error. I got real values for photfnu, phtflam1, and photplam from the FITS header of an image and computed the "constant" which indicates the "e" really means exponent or 3.33x10ˆ4 and not eˆ4. But maybe I am crazy.

Would it be better to change that to 3.33x10^4 to avoid confusion?

FDauphin commented 1 year ago

@mdlpstsci have the commits been pushed yet?

mdlpstsci commented 1 year ago

Confirmation that the "e" is a bad typo. Someone must have wanted to say 3.33 x 10E4 and did not quite make it there. This has been fixed.

I will push the changes momentarily.