Rename the task, its configClass, and all mentions of its name

python/lsst/cp/pipe/__init__.py

@@ -23,8 +23,8 @@
 
 from .version import *   # generated by sconsUtils unless you tell it not to
 try:
-    from .cpTask import *
+    from .runEotestTask import *
 except ImportError:
     import lsst.log as log
-    log.log("cp.pipe __init__", log.WARN, "eotest module not found; cpTask not available")
+    log.log("cp.pipe __init__", log.WARN, "eotest module not found; runEotestTask not available")
 from .makeBrighterFatterKernel import *

python/lsst/cp/pipe/cpTask.py → python/lsst/cp/pipe/runEotestTask.py

@@ -34,7 +34,7 @@
 import lsst.eotest.sensor as sensorTest
 
 
-class CpTaskConfig(pexConfig.Config):
+class RunEotestConfig(pexConfig.Config):
     """Config class for the calibration products production (CP) task."""
 
     ccdKey = pexConfig.Field(
@@ -162,7 +162,7 @@ def validate(self):
         override the validate() method here, and use it to set the output directory for each of the tasks
         based on the legal pexConfig parameter for the main task.
         """
-        log = lsstLog.Log.getLogger("cp.pipe.cpTaskConfig")
+        log = lsstLog.Log.getLogger("cp.pipe.runEotestConfig")
         if not self.eotestOutputPath:
             raise RuntimeError("Must supply an output path for eotest data. "
                                "Please set config.eotestOutputPath.")
@@ -179,12 +179,12 @@ def validate(self):
             getattr(self, task).output_dir = self.eotestOutputPath
 
 
-class CpTask(pipeBase.CmdLineTask):
+class RunEotestTask(pipeBase.CmdLineTask):
     """
-    Calibration (Products) Production (CP) task.
+    Task to run test stand data through eotest using a butler.
 
-    This task is used to produce the calibration products required to calibrate cameras.
-    Examples of such operations are as follows:
+    This task is used to produce an eotest report (the project's sensor acceptance testing package)
+    Examples of some of its operations are as follows:
     * Given a set of flat-field images, find the dark pixels and columns.
     * Given a set of darks, find the bright pixels and columns.
     * Given a set of Fe55 exposures, calulate the gain of the readout chain, in e-/ADU
@@ -194,7 +194,7 @@ class CpTask(pipeBase.CmdLineTask):
     * Given a set of bias frames, calculate the read noise of the system in e-.
     * Given a set of pocket-pumping exposures, find charge-traps in the silicon.
 
-    The CpTask.runEotestDirect() is only applicable to LSST sensors, and only for a specific type of dataset
+    The RunEotestTask.runEotestDirect() is only applicable to LSST sensors, and only for a specific type of dataset
     This method takes a dafPersistance.Butler corresponding to a repository in which a full eotest run has
     been taken and ingested, and runs each of the tasks in eotest directly, allowing for bitwise comparison
     with results given by the camera team.
@@ -203,11 +203,11 @@ class CpTask(pipeBase.CmdLineTask):
     regarding the inputs and outputs.
     """
 
-    ConfigClass = CpTaskConfig
-    _DefaultName = "cp"
+    ConfigClass = RunEotestConfig
+    _DefaultName = "runEotest"
 
     def __init__(self, *args, **kwargs):
-        """Constructor for the CpTask."""
+        """Constructor for the RunEotestTask."""
         if 'lsst.eotest.sensor' not in sys.modules:  # check we have eotest before going further
             raise RuntimeError('eotest failed to import')