DM-28092: Document that DiaPipeTask can only handle specific bands #70
Conversation
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
parejkoj
reviewed
Feb 9, 2021
doc/lsst.ap.pipe/apdb.rst
Outdated
| @@ -36,6 +36,9 @@ APDB configuration info uses the prefix ``diaPipe:apdb.``, with a colon, but is | |||
|
|
|||
| Note that the `~lsst.dax.apdb.ApdbConfig.db_url` field has no default; a value *must* be provided by the user. | |||
|
|
|||
| Additionally, the default set of observed bands allowed to be used in the pipeline are set by the columns available in the Apdb schema specified by `apdb.schema_file` and `apdb.extra_schema_file`. Should the user wish to use the pipeline on data containing bands not in the `ugrizy` system, they must add the appropriate columns to the Apdb schema and add the bands to | |||
There was a problem hiding this comment.
I think the everything here other than ...DiaPipelineConfig should be in double-backtics, since they aren't supposed to become links?
doc/lsst.ap.pipe/apdb.rst
Outdated
| @@ -36,6 +36,9 @@ APDB configuration info uses the prefix ``diaPipe:apdb.``, with a colon, but is | |||
|
|
|||
| Note that the `~lsst.dax.apdb.ApdbConfig.db_url` field has no default; a value *must* be provided by the user. | |||
|
|
|||
| Additionally, the default set of observed bands allowed to be used in the pipeline are set by the columns available in the Apdb schema specified by `apdb.schema_file` and `apdb.extra_schema_file`. Should the user wish to use the pipeline on data containing bands not in the `ugrizy` system, they must add the appropriate columns to the Apdb schema and add the bands to | |||
There was a problem hiding this comment.
What are the apdb.schema_file and apdb.extra_schema_file? Did you mean ApdbConfig. there? In that case, I think single-backticked ~lsst.dax.apdb.ApdbConfig.schema_file might then work as a link?
| @@ -36,3 +36,5 @@ to verify the output. | |||
| - `ApPipeConfig`: a config for customizing ``ApPipeTask`` for a particular dataset's needs. | |||
| Supported observatory packages should provide a :ref:`config override file <command-line-task-config-howto-obs>` that does most of the work. | |||
| - :file:`ApPipe.yaml`: a `~lsst.pipe.base.Pipeline` configuration for running the entire AP Pipeline in the newer, "Gen 3" framework | |||
|
|
|||
| By default the pipeline is limited to running on data observed in filters that match those in Rubin (that is `ugrizy`). In order to run on bands outside of these filters, one must add the associated columns to the `~lsst.dax.apdb.Apdb` schema and add the band names to the config of `~lsst.ap.association.DiaPipelineTask`. | |||
There was a problem hiding this comment.
I checked the usage guide and "that match those in Rubin" should be "that match those used by the Rubin Observatory LSST Camera".
https://project.lsst.org/documents/name-use-guide
I'd also say "running on data taken in filter bands whose names match" - the important thing is the band name, not the details of the filter itself.
| @@ -36,3 +36,5 @@ to verify the output. | |||
| - `ApPipeConfig`: a config for customizing ``ApPipeTask`` for a particular dataset's needs. | |||
| Supported observatory packages should provide a :ref:`config override file <command-line-task-config-howto-obs>` that does most of the work. | |||
| - :file:`ApPipe.yaml`: a `~lsst.pipe.base.Pipeline` configuration for running the entire AP Pipeline in the newer, "Gen 3" framework | |||
|
|
|||
| By default the pipeline is limited to running on data observed in filters that match those in Rubin (that is `ugrizy`). In order to run on bands outside of these filters, one must add the associated columns to the `~lsst.dax.apdb.Apdb` schema and add the band names to the config of `~lsst.ap.association.DiaPipelineTask`. | |||
There was a problem hiding this comment.
Please use one sentence per line style here.
https://developer.lsst.io/restructuredtext/style.html#text-wrapping
doc/lsst.ap.pipe/apdb.rst
Outdated
| @@ -36,6 +36,9 @@ APDB configuration info uses the prefix ``diaPipe:apdb.``, with a colon, but is | |||
|
|
|||
| Note that the `~lsst.dax.apdb.ApdbConfig.db_url` field has no default; a value *must* be provided by the user. | |||
|
|
|||
| Additionally, the default set of observed bands allowed to be used in the pipeline are set by the columns available in the Apdb schema specified by `apdb.schema_file` and `apdb.extra_schema_file`. Should the user wish to use the pipeline on data containing bands not in the `ugrizy` system, they must add the appropriate columns to the Apdb schema and add the bands to | |||
| the `validBands` config in `~lsst.ap.association.DiaPipelineConig`. | |||
There was a problem hiding this comment.
Please use one sentence per line style throughout.
https://developer.lsst.io/restructuredtext/style.html#text-wrapping
parejkoj
approved these changes
Feb 9, 2021
morriscb
force-pushed
the
tickets/DM-28092
branch
from
2c4d8c3
to
2150311
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.