-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add README files for pipelines directories.
- Loading branch information
Showing
2 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# 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. | ||
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 | ||
pipetask build \ | ||
-p $CP_VERIFY_DIR/pipelines/Latiss/VerifyBias.yaml \ | ||
--show pipeline | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# 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. |