Skip to content

Commit

Permalink
Merge branch 'tickets/DM-39465'
Browse files Browse the repository at this point in the history
  • Loading branch information
leeskelvin committed May 31, 2023
2 parents 8891c44 + 8f62698 commit 69144ff
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
8 changes: 4 additions & 4 deletions pipelines/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Pipeline Definitions

This directory contains pipeline definition YAML files which are used to verify calibration products with the LSST Science Pipelines.
The pipelines defined here are science ready and come in two flavors: generic ("ingredients") and camera-specific (within appropriately named sub-directories).
Use of camera-specific pipelines is strongly encouraged where possible as they are optimized for the particular characteristics of that camera.

The pipelines defined here tend to import other pipelines, including ingredient pipelines in the [_ingredients](_ingredients) directory.
To expand a pipeline YAML and resolve such imports for the purposes of visualizing it, the `pipetask build` command can be used.
The pipelines defined here come in three flavors: camera-specific (within named directories), camera-agnostic (top-level, if any), and building-block ingredients (within the [\_ingredients](_ingredients) directory).
Pipelines within the ingredients directory are meant to be imported by other pipelines, and are not intended to be used directly by end-users.

The `pipetask build` command can be used to expand a pipeline YAML and resolve any imports for the purposes of visualizing it.
For example, to visualize the verification of a bias for the [LATISS camera pipeline](https://github.com/lsst/cp_verify/blob/main/pipelines/Latiss/VerifyBias.yaml) pipeline, run:

```bash
Expand Down
3 changes: 2 additions & 1 deletion pipelines/_ingredients/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Pipeline Definition Ingredients

This directory contains ingredient pipeline definition YAML files.

The pipelines defined here are intended to be used as the basic blocks for calibration verification.
As such, they are not intended to be used directly by end-users for science purposes.

Science ready pipeline definitions for specific cameras are located in the [pipelines](..) directory.
User-facing pipeline definitions are located in the [pipelines](..) directory.

0 comments on commit 69144ff

Please sign in to comment.