record_step_status

jwst.stpipe.utilities.record_step_status(datamodel, cal_step, success=True, status=None)

Record whether or not a step completed in meta.cal_step.

Parameters:

datamodelJwstDataModel, ModelContainer, ModelLibrary

This is the datamodel or container of datamodels to modify in place

cal_stepstr

The attribute in meta.cal_step for recording the status of the step

successbool, optional

If True, set the status to “COMPLETE”. If False, set “FAILED”. Ignored if status is not None.

status{“COMPLETE”, “SKIPPED”, “FAILED”}, optional

The step status to record.