-
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 for bps templates for calibration verification.
- Loading branch information
Showing
1 changed file
with
45 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,45 @@ | ||
| BPS Template Files for Calibration Construction | ||
| =============================================== | ||
|
|
||
| This directory contains BPS template files for calibration verification. These | ||
| are meant to conform to the naming conventions laid out in | ||
| [DMTN-222](https://dmtn-222.lsst.io). | ||
|
|
||
| Overview | ||
| -------- | ||
|
|
||
| These template files are only part of calibration verification. They are meant | ||
| to be flexible enough to use for both test verification into a user collection, | ||
| as well as final verification. | ||
|
|
||
| The templates rely on a lot of exported environment variables, defined | ||
| below. Note that because the bps file does not share an env with the caller all | ||
| the env vars must be explicitly exported. | ||
|
|
||
| Environment Variables | ||
| --------------------- | ||
|
|
||
| These are the environment variables that must be used. Examples are substituted in. | ||
|
|
||
| * `export USER_CALIB_PREFIX=""` or `export USER_CALIB_PREFIX=u/erykoff/`: Set to a blank string for official calibrations, or the user collection prefix (**with trailing slash**). | ||
| * `export INSTRUMENT=LSSTComCam`: The name of the instrument. | ||
| * `export TICKET=DM-46562`: The name of the ticket assocated with the calib construction. | ||
| * `export REPO=/repo/main`: The name of the butler repository to generate calibs. | ||
| * `export RAW_COLLECTION=LSSTComCam/raw/all`: The name of the raw data collection. | ||
| * `export CALIB_COLLECTIONS=LSSTComCam/calib/DM-46825`: Comma-separated list of curated or previously generated calibration collections to use as a starting point. | ||
| * `export TAG=newCalibs`: A human-readable tag to help indicate why a set of calibs were built (should also be findable from the ticket name). | ||
| * `export VERIFY_RERUN=20250122a`: The rerun name to indicate when the calibrations were generated. | ||
| * `export SELECTION_BIAS_V="instrument='LSSTComCam' and selection_string"`: The selection of raws to verify the bias. | ||
| * `export SELECTION_DARK_V="instrument='LSSTComCam' and selection_string"`: The selection of raws to verify the dark. | ||
| * `export SELECTION_PTC_V="instrument='LSSTComCam' and selection_string"`: The selection of raws to verify the PTC. | ||
| * `export SELECTION_PTC_LINEARIZER_V=$SELECTION_PTC_V`: The selection of raws to verify the linearizer; usually will be the same as the PTC selection. | ||
| * `export SELECTION_PTC_BFK_V=$SELECTION_PTC_V`: The selection of raws to verify the brighter-fatter kernel; usually will be the same as the PTC selection. | ||
| * `export SELECTION_FLAT_g_V="instrument='LSSTComCam and selection_string": The selection of raws to verify the g-band flat. See below for additional info. | ||
|
|
||
| A Note on Flat Generation | ||
| ------------------------- | ||
|
|
||
| Due to limitations in BPS environment variable expansion, we have one template | ||
| file for each band. There are template files for each of ugrizy. Note that it is | ||
| **strongly** recommended that the relevant physical filter be used in the | ||
| `selection_string` constraint on each flat selection. |