spacetelescope / jwst_mast_query

Command line tool for querying MAST and downloading JWST data products
BSD 3-Clause "New" or "Revised" License
18 stars 11 forks source link

Add documentation of config file parameters to inline help #24

Closed jdavies-st closed 1 year ago

jdavies-st commented 2 years ago

Currently the inline help

jwst_download.py --help

has less information (and some inaccurate listing of defaults) about the possible parameters one can use, relative to the information in the README describing the config file parameters. It would be good to merge that config file parameter documentation into the inline help, including the current updated defaults.

An example is filetypes default is currently uncal but the inline help says it is None:

  -f FILETYPES [FILETYPES ...], --filetypes FILETYPES [FILETYPES ...]
                        List of product filetypes to get, e.g., _uncal.fits or
                        _uncal.jpg. If only letters, then _ and .fits are
                        added, for example uncal gets expanded to _uncal.fits.
                        Typical image filetypes are uncal, rate, rateints, cal
                        (default=None)

and

filetypes: ['uncal'] | List of file types to select in the product table, e.g., _uncal.fits or uncal.jpg. If no suffix is given, .fits is appended. If only letters, then and .fits are added. For example, 'uncal' gets expanded to _uncal.fits. Typical image filetypes are uncal, rate, rateints, cal. For downloading a single file type, the brackets must still surround the file suffix, as the script expects a list. A relatively complete list of options includes: ['_segm.fits', '_asn.json', '_pool.csv', '_i2d.jpg', '_thumb.jpg', '_cat.ecsv', '_i2d.fits', '_uncal.fits', '_uncal.jpg', '_cal.fits', '_trapsfilled.fits', '_cal.jpg', '_rate.jpg', '_rateints.jpg', '_trapsfilled.jpg', '_rate.fits', '_rateints.fits'] See the JWST calibration pipeline documentation for a complete list.

Btw, great tool. Everyone I know is using it, as the interface is simple. 🚀