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

Class Inheritance Diagram