Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DM-42921: Update the getting started guide #208

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DM-42921: Update the getting started guide #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions doc/lsst.analysis.tools/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,12 +342,12 @@ to add the class to a pipeline.
An example pipeline to run our new plot
tasks:
testNewPlot:
class: lsst.analysis.tools.tasks.ObjectTableTractAnalysisTask
config:
connections.outputName: testNewPlot
plots.newPlot: newPlotMetric
python: |
from lsst.analysis.tools.analysisPlots import *
class: lsst.analysis.tools.tasks.ObjectTableTractAnalysisTask
config:
connections.outputName: testNewPlot
atools.newPlotMetric: newPlotMetric
python: |
from lsst.analysis.tools.atools import *

The class line assumes that we want to run the plot on an objectTable_tract. Each different dataset type has
its own associated task. Many tasks already exist for different dataset types but depending on what you want
Expand All @@ -361,6 +361,7 @@ Once we have the pipeline we can run it, the same as we would run other pipetask
-b /sdf/group/rubin/repo/main/butler.yaml
-i HSC/runs/RC2/w_2022_28/DM-35609
-o u/sr525/newPlotTest
--instrument lsst.obs.subaru.HyperSuprimeCam
--register-dataset-types --prune-replaced=purge --replace-run

Let's look at each of the parts that go into the command.
Expand Down Expand Up @@ -389,6 +390,13 @@ Let's look at each of the parts that go into the command.

-o is the output collection that you want the plots to go into. The standard way of organising things is to put them into u/your-user-name.

.. code-block:: bash

--instrument lsst.obs.subaru.HyperSuprimeCam

--instrument tells the pipetask that you are running on HSC data, for example this makes the plot/metric run
over the HsC bands, g, r, i, z and y. It also applies other instrument specific config overrides.

.. code-block:: bash

--register-dataset-types --prune-replaced=purge --replace-run
Expand Down
Loading