spacetelescope / jwst_validation_notebooks

JWST Pipeline Validation Notebooks
BSD 3-Clause "New" or "Revised" License
5 stars 24 forks source link

Create flat_miri_mrs_test.ipynb #146

Closed mengesser closed 3 years ago

mengesser commented 3 years ago

Creating a test for the flat_field step in spec2 as it pertains to MIRI MRS

cracraft commented 3 years ago

Hi, I'm going to have a few requests for updates. First, the first cell needs to start with a title block of a specific format, or the linking to the webpage won't happen properly and the output of the notebook won't show up. Please add text of this format to the top cell of your notebook: '

JWST Pipeline Validation Testing Notebook: Pipeline, step, instrument

Instruments Affected: MIRI

Tested on MIRI Simulated data

The important part of that is the ' (with no quotes) followed by a single # and the title on the following line. Ok, the code string for the header isn't showing up properly in this box, but pull up the template file and go into edit mode to grab the text string needed in between the arrow brackets.

Second, you specify using a crds context of os.environ['CRDS_CONTEXT']='jwst_0619.pmap', and that pmap is pretty far out of date. The current context is 732. I feel like this is something you copied from another notebook, but maybe not something you really want to do. If you want the test to test the latest version of the reference files, just remove that line, and it will call the most recent version.

Third, please add a cell with the author name and date in it. If you'd like to see the typical formatting for a notebook, check out the template notebook in this repo.

The notebook ran fine and had no errors, but I'll wait on these updates before merging.

mengesser commented 3 years ago

Okay, thanks Misty. I believe I've now addressed all of these points. Let me know if any other changes are necessary!