Skip to content

Commit

Permalink
Update comments in pipeline definitions to use apdb-cli command
Browse files Browse the repository at this point in the history
  • Loading branch information
andy-slac committed Apr 2, 2024
1 parent da49e0b commit 6187171
Show file tree
Hide file tree
Showing 11 changed files with 30 additions and 31 deletions.
6 changes: 3 additions & 3 deletions pipelines/DECam/ApPipe.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
description: End to end AP pipeline specialized for DECam
# (1) Run $AP_PIPE_DIR/pipelines/DECam/RunIsrForCrosstalkSources.yaml
# (2) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c db_url="sqlite:////project/user/association.db"
# (2) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (3) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs should match the make_apdb.py configs)
# (diaPipe configs should match the apdb-cli parameters)

instrument: lsst.obs.decam.DarkEnergyCamera
imports:
Expand Down
6 changes: 3 additions & 3 deletions pipelines/DECam/ApPipeCalibrate.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
description: End to end AP pipeline specialized for DECam
# (1) Run $AP_PIPE_DIR/pipelines/DECam/RunIsrForCrosstalkSources.yaml
# (2) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c db_url="sqlite:////project/user/association.db"
# (2) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (3) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs should match the make_apdb.py configs)
# (diaPipe configs should match the apdb-cli parameters)

instrument: lsst.obs.decam.DarkEnergyCamera
imports:
Expand Down
8 changes: 4 additions & 4 deletions pipelines/DECam/ApPipeWithFakes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ description: DECam AP Pipeline with synthetic/fake sources. Templates are inputs
# Remember:
# (0) Ensure median calibration products and template coadds exist for the data being processed
# (1) Run $AP_PIPE_DIR/pipelines/DECam/RunIsrForCrosstalkSources.yaml
# (2) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c db_url="sqlite:////project/user/association.db"
# (2) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (3) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs must match the make_apdb.py configs)
# (diaPipe configs must match the apdb-cli parameters)

instrument: lsst.obs.decam.DarkEnergyCamera
imports:
- location: $AP_PIPE_DIR/pipelines/_ingredients/ApPipeWithFakes.yaml
exclude: # These tasks frome from DECam's ApPipe.yaml instead
exclude: # These tasks come from DECam's ApPipe.yaml instead
- processCcd
- location: $AP_PIPE_DIR/pipelines/DECam/ApPipe.yaml
include: # All other tasks come from ApPipeWithFakes.yaml instead
Expand Down
6 changes: 3 additions & 3 deletions pipelines/HSC/ApPipe.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
description: End to end AP pipeline specialized for HSC
# (1) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c db_url="sqlite:////project/user/association.db"
# (1) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (2) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs should match the make_apdb.py configs)
# (diaPipe configs should match the apdb-cli parameters)

instrument: lsst.obs.subaru.HyperSuprimeCam
imports:
Expand Down
6 changes: 3 additions & 3 deletions pipelines/HSC/ApPipeCalibrate.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
description: End to end AP pipeline specialized for HSC
# (1) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c db_url="sqlite:////project/user/association.db"
# (1) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (2) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs should match the make_apdb.py configs)
# (diaPipe configs should match the apdb-cli parameters)

instrument: lsst.obs.subaru.HyperSuprimeCam
imports:
Expand Down
6 changes: 3 additions & 3 deletions pipelines/HSC/ApPipeWithFakes.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
description: HSC AP Pipeline with synthetic/fake sources. Templates are inputs.
# Remember:
# (0) Ensure median calibration products and template coadds exist for the data being processed
# (1) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c db_url="sqlite:////project/user/association.db"
# (1) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (2) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs must match the make_apdb.py configs)
# (diaPipe configs must match the apdb-cli parameters)

instrument: lsst.obs.subaru.HyperSuprimeCam
imports:
Expand Down
6 changes: 3 additions & 3 deletions pipelines/LSSTCam-imSim/ApPipe.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
description: End to end AP pipeline specialized for ImSim.
# (1) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c db_url="sqlite:////project/user/association.db"
# (1) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (2) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs should match the make_apdb.py configs)
# (diaPipe configs should match the apdb-cli parameters)

instrument: lsst.obs.lsst.LsstCamImSim
imports:
Expand Down
6 changes: 3 additions & 3 deletions pipelines/LSSTCam-imSim/ApPipeCalibrate.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
description: End to end AP pipeline specialized for ImSim
# (1) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c db_url="sqlite:////project/user/association.db"
# (1) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (2) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs should match the make_apdb.py configs)
# (diaPipe configs should match the apdb-cli parameters)

instrument: lsst.obs.lsst.LsstCamImSim
imports:
Expand Down
7 changes: 3 additions & 4 deletions pipelines/LSSTCam-imSim/ApPipeWithFakes.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
description: AP pipeline with synthetic/fakes sources specialized for ImSim
# (1) Execute `make_apdb.py`, e.g.,
# make_apdb.py -c isolation_level=READ_UNCOMMITTED
# -c db_url="sqlite:////project/user/association.db"
# (1) Execute `apdb-cli create-sql`, e.g.,
# apdb-cli create-sql "sqlite:////project/user/association.db" apdb_config.py
# (2) Run this pipeline, setting appropriate diaPipe configs
# (diaPipe configs should match the make_apdb.py configs)
# (diaPipe configs should match the apdb-cli parameters)

instrument: lsst.obs.lsst.LsstCamImSim
imports:
Expand Down
2 changes: 1 addition & 1 deletion pipelines/_ingredients/ApPipe.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: End to end Alert Production pipeline.
# for each camera. Those pipelines import this general AP pipeline.
#
# NOTES
# Remember to run make_apdb.py and use the same configs for diaPipe
# Remember to run `apdb-cli create-sql` and use the same configs for diaPipe
# A db_url is always required, e.g.,
# -c diaPipe:apdb.db_url: 'sqlite:////project/user/association.db'
# Option to specify connection_timeout for sqlite APDBs encountering lock errors, i.e.,
Expand Down
2 changes: 1 addition & 1 deletion pipelines/_ingredients/ApPipeCalibrate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: End to end Alert Production pipeline
# for each camera. Those pipelines import this general AP pipeline.
#
# NOTES
# Remember to run make_apdb.py and use the same configs for diaPipe
# Remember to run `apdb-cli create-sql` and use the same configs for diaPipe
# A db_url is always required, e.g.,
# -c diaPipe:apdb.db_url: 'sqlite:////project/user/association.db'
# Option to specify connection_timeout for sqlite APDBs encountering lock errors, i.e.,
Expand Down

0 comments on commit 6187171

Please sign in to comment.