Details
-
Type:
Improvement
-
Status: Won't Fix
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: pipe_tasks
-
Labels:None
-
Epic Link:
-
Team:Data Release Production
Description
To verify and test the DM science pipelines we are running verification datasets through both the AP and DRP pipelines which essentially means a handful of commandLineTasks. This is challenging because many of the people working on the verification datasets are new to DM and there is very little documentation on the main commandLineTasks. Therefore, we request that Doxygen documentation (or similar) should be written for these tasks that give the inputs, outputs, options and general outline of the steps in each program. Also, a list of the important/often-used config options would be extremely useful especially for tasks that hundreds of config options.
This ticket is specifically for assembleCoadd.
Done for Gen2 usage:
https://pipelines.lsst.io/modules/lsst.pipe.tasks/index.html
https://pipelines.lsst.io/py-api/lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddTask.html#lsst.pipe.tasks.assembleCoadd.CompareWarpAssembleCoaddTask