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-33150: Add header anchors to pipeline guide. #226

Merged
merged 1 commit into from
Jan 21, 2022
Merged

DM-33150: Add header anchors to pipeline guide. #226

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 18 additions & 0 deletions doc/lsst.pipe.base/creating-a-pipeline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ verifying configuration, specifying subsets of tasks, creating `Pipeline`\ s
using composition, a basic introduction to options when running `Pipeline`\
s, and discussing common conventions when creating `Pipelines`.

.. _pipeline_creating_intro:

.. _pipeline_creating_format:

----------------
A Basic Pipeline
----------------
Expand Down Expand Up @@ -99,6 +103,8 @@ execution graph of the specified tasks. A consequence of this is if a
pipeline does not define all the tasks required to generate all needed inputs
and outputs it will get caught before any execution occurs.

.. _pipeline_creating_config:

-----------------
Configuring Tasks
-----------------
Expand Down Expand Up @@ -179,6 +185,8 @@ the previous one to use the ``python`` key.
config.calibrate.astrometry.sourceSelector['references'].flags.bad = flags


.. _pipeline_creating_parameters:

----------
Parameters
----------
Expand Down Expand Up @@ -222,6 +230,8 @@ config field use the same value, it is not restricted to dataset types.
talk about how to dynamically set a ``parameters`` value at `Pipeline`
invocation time.

.. _pipeline_creating_contracts:

----------------------------------
Verifying Configuration: Contracts
----------------------------------
Expand Down Expand Up @@ -285,6 +295,8 @@ validation. It is possible for someone to change the configuration of one of
the fields before a `Pipeline` is run. Because of this, ``contracts`` should
always be written without regards to how ``parameters`` are used.

.. _pipeline_creating_subsets:

-------
Subsets
-------
Expand Down Expand Up @@ -327,6 +339,8 @@ Once a ``subset`` is created the label associated with it can be used in
any context where task labels are accepted. Examples of this will be shown
in :ref:`pipeline-running-intro`.

.. _pipeline_creating_imports:

-----------
Importing
-----------
Expand Down Expand Up @@ -384,6 +398,8 @@ the label with be considered re-declared and the declaration in the current
is dropped.


.. _pipeline_creating_obs_package:

--------------------------------------
obs\_* package overrides for Pipelines
--------------------------------------
Expand Down Expand Up @@ -472,6 +488,8 @@ specifies a subset based on our previous example would look like the following:

``$PIPE_TASKS_DIR/pipelines/DRP.yaml#processCcd``

.. _pipeline_conventions:

--------------------
Pipeline conventions
--------------------
Expand Down