EngDBLogStep

class jwst.engdblog.EngDBLogStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)

Bases: JwstStep

Pipeline step to retrieve selected engineering mnemonic values.

Notes

This is primarily developed to satisfy the following DMS requirements. However, it has been developed in hopes that it may provide useful diagnostics and/or as an example of step writing and engineering DB access.

• DMS-256 Calibration software shall access the DMS engineering database in order to derive the engineering information needed for science instrument calibration.

• DMS-458 The Calibration software shall retrieve relevant engineering data from the Engineering Database.

Create a Step instance.

Parameters:

namestr

The name of the Step instance. Used in logging messages and in cache filenames. If not provided, one will be generated based on the class name.

parentStep

The parent step of this step. Used to determine a fully-qualified name for this step, and to determine the mode in which to run this step.

config_filestr or pathlib.Path

The path to the config file that this step was initialized with. Use to determine relative path names of other config files.

_validate_kwdsbool

Validate given kws against specs/config.

**kwsdict

Additional parameters to set. These will be set as member variables on the new Step instance.

Attributes Summary

spec

Methods Summary

process(mnemonics)

Retrieve selected engineering mnemonic values.

Attributes Documentation

spec

stime = string(default='2022-01-25 02:00:00')  # Start time
etime = string(default='2022-01-26 02:10:00')  # End time
verbosity = option('initial', 'all', default='initial')  # How much to report.
engdb_url = string(default=None)  # Mock url

Methods Documentation

process(mnemonics)

Retrieve selected engineering mnemonic values.

Parameters:

mnemonicsstr or list of str

The list of mnemonics to retrieve.

Returns:

resultdict

The specified mnemonics and their values in the form of {mnemonic: values[, ...]}.