DM-38962: Update docs to new API #91
Conversation
|
|
||
| **contexts** | ||
|
|
||
| | Generic settings to be applied in a given circumstance. For example overrides that are specific to a coadd or visit level plot/metric such as the default flag selector which is different between coadd and visit analysis. | ||
|
|
||
| **interfaces** | ||
|
|
||
| | Interfaces are the framework level code which is used as a basis to build/interact with analysis tools package. You should not have to modify anything in here to be able to add new metrics or plots. |
There was a problem hiding this comment.
These feel like definition lists, but aren't being printed as such because of the leading |. If you start this paragraph with a 4-space indent, this will instead display as a definition, making this and all other entries easier to read.
There was a problem hiding this comment.
This was an intentional layout choice.
There was a problem hiding this comment.
But if you like the other way I have no strong opinions and have changed it.
| The current actions that are available are detailed :doc:`here<action-types>`. Most common requests are already coded up and | ||
| please try to reuse actions that already exist before making your own. Please also try to make actions as | ||
| reusable as possible so that other people can also use them. |
There was a problem hiding this comment.
General comment: if you structure your ReST with the philosophy of one sentence per line, it will make future edits easier to parse.
| 4. The command line --config and --config-file options | ||
| 5. The pipeline file configs |
There was a problem hiding this comment.
My understanding is that 4 and 5 should be switched here. I.e., anything you give on the command line at pipetask run time will always take precedence.
I think this block may be missing a few options as well. Let me ping @natelust to weigh in.
|
|
||
| Due to this configs that are obs package specific should not be specified in the pipeline file because they | ||
| overwrite the obs specific configs. For example the bands option, if that is set in the pipeline file it will | ||
| overwrite the obs package which means that if you try to apply the same pipeline to hsc and DC2 data (for |
| The various flag selectors allow you to specify which bands the flags are applied in. If you want the selector | ||
| to be applied in the bands that the plot is being made in then the flag config option should be set to []. | ||
|
|
||
| Where is the line between python and yaml? |
There was a problem hiding this comment.
Uppercase Python, uppercase YAML.
| @@ -76,9 +76,6 @@ def getInputSchema(self) -> KeyedDataSchema: | |||
| def __call__(self, data: KeyedData, **kwargs) -> Vector: | |||
| """Select on the given flags | |||
|
|
|||
There was a problem hiding this comment.
Does this belong on this ticket? It seems like a selectors fix, but is just removing Parameters without replacing it. From what I can tell, this looks like it needs data at least?
There was a problem hiding this comment.
I don't think this file needs the word guide in the name. We don't have it for getting-started, and I think it adds unnecessary length. I also imagine this page being less of a guide and more of a reference, so there's that too.
There was a problem hiding this comment.
I think a better focus for this page would be FAQs. I.e.: doc/lsst.analysis.tools/faqs.rst. Each block is phrased as a question, and we then periodically update this page as new frequently asked questions emerge.
|
Thanks Sophie, comments above. Happy to go ahead with this thereafter and build upon it. |
sr525
force-pushed
the
tickets/DM-38962
branch
2 times, most recently
from
0832fd4
to
ea393f0
Compare
No description provided.