STPIPE

For Users

• Steps
  • Configuring a Step
  • Running a Step from a parameter file
• Pipelines
  • Configuring a Pipeline
  • Running a Pipeline
  • Hooks
• 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 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
• Step I/O Design
  • API Summary
  • Design
  • Input and JWST Conventions
  • Output

Base Classes

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

A JWST pipeline step (jwst.stpipe.Step).

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.

load_as_level2_asn(obj)

Load object as an association.

Loads the specified object into a Level2 association. If necessary, prepend Step.input_dir to all members.

Parameters:

objobject

Object to load as a Level2 association

Returns:

associationobject

Association from jwst.associations.lib.rules_level2_base.DMSLevel2bBase

load_as_level3_asn(obj)

Load object as an association.

Loads the specified object into a Level3 association. If necessary, prepend Step.input_dir to all members.

Parameters:

objobject

Object to load as a Level3 association

Returns:

associationobject

Association from jwst.associations.lib.rules_level3_base.DMS_Level3_Base

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

A JWST pipeline (jwst.stpipe.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.

Utilities

jwst.stpipe.utilities Module

Utilities for working with JWST pipeline steps.

Functions

all_steps()	List all classes subclassed from Step.
load_local_pkg(fpath)	Make a generator to list all modules under fpath.
folder_traverse(folder_path[, ...])	Traverse folder and generate full file paths for each file found.
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.
invariant_filename(save_model_func)	Restore meta.filename after save_model.