Details
-
Type:
Bug
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:None
-
Story Points:0.4
-
Epic Link:
-
Team:SQuaRE
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
Issue Links
- mentioned in
-
Page Loading...
Activity
(I think this is a Jonathan Sick issue, but obviously reassign if I'm wrong)
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.
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.
Do we want to merge Colin Slater's branch https://github.com/lsst/pipelines_lsst_io/tree/u/ctslater/package-dev ? It's been 4 years so I'm wondering if we are better off merging what we have over waiting for something better.
I'm learning towards closing this on the basis of solving the original problem with the RSP / Notebook Aspect documentation back in 2018 and we can merge other user branches for Pipelines as needed via their own PRs/tickets. Sound good?
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'