spacetelescope / stginga

Ginga products specific to STScI data analysis.
https://stginga.readthedocs.io
BSD 3-Clause "New" or "Revised" License
6 stars 10 forks source link

Add more description of how to use a plug-in to the docs #231

Closed eas342 closed 10 months ago

eas342 commented 10 months ago

Description

Please add an instruction for Dummies like me! I wanted to try out DQInspect as a way to view data quality information. I loaded a JWST image with:

stginga jw01335004001_03101_00002_nrs1_rate.fits&

but did not see anything the Dialogs tab as described here (https://stginga.readthedocs.io/en/stable/stginga/plugins_manual/dqinspect.html). So, I thought I was doing something wrong with my installation/plugins/settings, etc.

I didn't realize that all I had to do was click on Operation --> Custom --> DQInspect I spent a while trying different things on the command line and customization to get the plug-in to load only to realize I needed to use the Operation button!

Additional context

pllim commented 10 months ago

Hello. I am glad you found this package useful and I apologize for the confusion. Would something like https://github.com/spacetelescope/stginga/pull/232 make things better for you? If not, please provide suggestions on what you expect to see. Thanks!

eas342 commented 10 months ago

Indeed this package is very useful - DQInspect is just the tool I was looking for (and I think many other JWST users)! Thanks for adding that to the docs!