DM-42556: Update the FAQs #187
Merged
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
leeskelvin
reviewed
Jan 19, 2024
doc/lsst.analysis.tools/faqs.rst
Outdated
| pipelines contained in analysis tools can. As an example lets look at the plots and metrics calculated from | ||
| matching to the reference catalogues. First there is a task that matches the input data to the reference | ||
| catalogue. This then saves in the butler the matched output so that it can be read in later by multiple | ||
| atools and also used in a notebook or script if further QA is requried. After the matched catalogue is made |
leeskelvin
reviewed
Jan 19, 2024
doc/lsst.analysis.tools/faqs.rst
Outdated
| atools and also used in a notebook or script if further QA is requried. After the matched catalogue is made | ||
| the plotting/metric/calculation atools read it in, then act on it. The atools themselves do not butler put | ||
| the metric/plot/calculated data but return them to the task that ran them which then puts them in the right | ||
| place. Most of this is hidden from the user and the atools handle putting plots and metrics themselves. |
There was a problem hiding this comment.
This last sentence is a little confusing to me - are you using "atools" here to refer to "an analysis tool" or "analysis_tools"? If the former, as in the previous sentence, then I don't think this is accurate.
I'd recommend reserving "atools" for referring to individual analysis tools, and writing out the full "analysis tools" when referring to the complete package.
leeskelvin
reviewed
Jan 19, 2024
doc/lsst.analysis.tools/faqs.rst
Outdated
|
|
||
| No, while a lot of the plots and metrics are written to work on tables (or keyed data of some variety) you can | ||
| implement tasks to read in and manipulate any sort of data. If you have a specific datatype that you are | ||
| struggling with please reach out to #rubinobs-analysis-tools-support on slack. |
leeskelvin
approved these changes
Jan 19, 2024
|
General comment: I'd strongly recommend the "1 sentence per line" approach for |
sr525
force-pushed
the
tickets/DM-42556
branch
from
d1f28c6
to
87f307c
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.