STPIPE

For Users

• Steps
  • Configuring a Step
  • Running a Step from a parameter file
• Pipelines
  • Configuring a Pipeline
  • Running a Pipeline
  • Hooks
• Logging
  • Logging configuration
  • Example
• ASDF Parameter Files
  • File Contents
  • Python API
  • Parameter Files as Reference Files
• Configuration (CFG) Files
• Executing a pipeline or pipeline step via call()
  • Where are the results?
• Executing a pipeline or pipeline step directly, or via run()
• Parameter Files
• CFG Usage Deprecation Notice

For Developers

• Steps
  • Writing a step
  • Making a simple commandline script for a step
• Pipelines
  • Writing a Pipeline
• Logging
  • Logging from a Step or Pipeline
  • Logging from library code
• Step I/O Design
  • API Summary
  • Design
  • Input and JWST Conventions
  • Output

jwst.stpipe Package

JWST implementation of steps and pipelines.

Functions

record_step_status(datamodel, cal_step[, ...])	Record whether or not a step completed in meta.cal_step.
query_step_status(datamodel, cal_step)	Query the status of a step in meta.cal_step.

Classes

Step	alias of JwstStep
Pipeline	alias of JwstPipeline

Base Classes

class jwst.stpipe.core.JwstStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)

A JWST pipeline step.

Create a Step instance.

Parameters:

• name (str, optional) – 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.

• parent (Step instance, optional) – 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_file (str or pathlib.Path, optional) – The path to the config file that this step was initialized with. Use to determine relative path names of other config files.

• **kws (dict) – Additional parameters to set. These will be set as member variables on the new Step instance.

class jwst.stpipe.core.JwstPipeline(*args, **kwargs)

A JWST pipeline.

JwstPipeline needs to inherit from Pipeline, but also be a subclass of JwstStep so that it will pass checks when constructing a pipeline using JwstStep class methods.

See Step for the parameters.