Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-39465: Standardize pipelines README files post-RFC-927 #71

Merged
merged 1 commit into from
May 31, 2023
Merged

DM-39465: Standardize pipelines README files post-RFC-927 #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions pipelines/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Pipeline Definitions

This directory contains pipeline definition YAML files which are used when processing data with the LSST Science Pipelines.
The pipelines defined here are science ready and come in two flavors: generic (top-level) and camera-specific (within sub-directories).
Use of camera-specific pipelines is 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 step 1 subset of the [LATISS DRP pipeline](https://github.com/lsst/drp_pipe/blob/main/pipelines/LATISS/DRP.yaml) pipeline, run:
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 `step1` subset from the [LATISS DRP pipeline](https://github.com/lsst/drp_pipe/blob/main/pipelines/LATISS/DRP.yaml) pipeline, run:

```bash
pipetask build \
Expand Down
3 changes: 2 additions & 1 deletion pipelines/_ingredients/README.md
View file
Open in desktop
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 building blocks for more complex pipelines.
As such, they are not intended to be used directly by end-users for science purposes.

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