Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-14586

Documentation for developing Science Pipelines packages is missing a step

    Details

      Description

      The documentation at https://nb.lsst.io/science-pipelines/development-tutorial.html  describes how to add a new Task to the pipe_tasks package in the Notebook aspect. In 'Step 2: clone an existing package' a step should be added to check out the branch/tag that is compatible with the  base lsst_distrib installation.

      The step is also missing in the LSST Science Pipelines documentation:  https://pipelines.lsst.io/install/package-development.html. Colin Slater has already provided a draft fix at https://pipelines.lsst.io/v/u-ctslater-package-dev/install/package-development.html :  '2. Checkout the appropriate version'  This fix should also be propagated to the notebook aspect documentation as well. 

        Attachments

          Activity

          Hide
          lguy Leanne Guy added a comment -

          There is another error at : Step 5: set up the package for notebooks¶

          'setup -k -r ~/notebooks/pipe_base' should be 'setup -k -r ~/notebooks/pipe_tasks'

          Show
          lguy Leanne Guy added a comment - There is another error at : Step 5: set up the package for notebooks¶ 'setup -k -r ~/notebooks/pipe_base' should be 'setup -k -r ~/notebooks/pipe_tasks'
          Hide
          swinbank John Swinbank added a comment -

          (I think this is a Jonathan Sick issue, but obviously reassign if I'm wrong)

          Show
          swinbank John Swinbank added a comment - (I think this is a Jonathan Sick issue, but obviously reassign if I'm wrong)
          Hide
          jsick Jonathan Sick added a comment -

          I've got the nb.lsst.io-part of this ticket covered in https://github.com/lsst-dm/nb_lsst_io/pull/2

          I'll work on the pipelines.lsst.io aspect next.

          Show
          jsick Jonathan Sick added a comment - I've got the nb.lsst.io-part of this ticket covered in https://github.com/lsst-dm/nb_lsst_io/pull/2 I'll work on the pipelines.lsst.io aspect next.
          Hide
          jsick Jonathan Sick added a comment -

          I've merged the nb.lsst.io portion of this work. With Simon Krughoff's help I advocate that developers always use a recent daily image when developing from JupyterLab. There's not value in developing against an old checkout since that work would have to be forward-ported to master anyways before being merged. I'll take a similar approach with the pipelines.lsst.io documentation.

          Show
          jsick Jonathan Sick added a comment - I've merged the nb.lsst.io portion of this work. With Simon Krughoff 's help I advocate that developers always use a recent daily image when developing from JupyterLab. There's not value in developing against an old checkout since that work would have to be forward-ported to master anyways before being merged. I'll take a similar approach with the pipelines.lsst.io documentation.

            People

            • Assignee:
              jsick Jonathan Sick
              Reporter:
              lguy Leanne Guy
              Watchers:
              John Swinbank, Jonathan Sick, Leanne Guy
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:

                Summary Panel