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

Re-work DMTN-023 as a quick start tutorial

    XMLWordPrintable

    Details

      Description

      This ticket covers creating a Getting Started tutorial for pipelines.lsst.io. The aim is to let a person who has never used the pipelines have a hands-on experience with the Stack to understand its patterns and capabilities and develop good feelings for it.

      The best route is to adapt content from https://dmtn-023.lsst.io:

      • Rework as a tutorial, with deeper explanations moved to framework processing context docs.
      • Update the tutorial so that it works.

        Attachments

          Issue Links

            Activity

            No builds found.
            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-10635 [ 32584 ]
            Hide
            jsick Jonathan Sick added a comment -

            Starting by running the tutorial. Working around issues like:

            • can't use CI_HSC_DIR environment variable with lsstsw installs.
            • PS1 reference catalog changes the set up directions.
            • Can't assume that MPI will work for everyone out-of-the-box with singleFrameDriver.py
            Show
            jsick Jonathan Sick added a comment - Starting by running the tutorial. Working around issues like: can't use CI_HSC_DIR environment variable with lsstsw installs. PS1 reference catalog changes the set up directions. Can't assume that MPI will work for everyone out-of-the-box with singleFrameDriver.py
            jsick Jonathan Sick made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-10834 [ DM-10834 ]
            Hide
            jsick Jonathan Sick added a comment -

            We'll have to avoid -j 2 or greater with processCcd.py in the quick start until the DM-10834 issue is resolved.

            Show
            jsick Jonathan Sick added a comment - We'll have to avoid -j 2 or greater with processCcd.py in the quick start until the DM-10834 issue is resolved.
            jsick Jonathan Sick made changes -
            Component/s Stack Documentation and UX [ 12880 ]
            Story Points 2.8
            jsick Jonathan Sick made changes -
            Story Points 2.8 5
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-10340 [ DM-10340 ]
            jsick Jonathan Sick made changes -
            Reviewers Frossie Economou, John Swinbank, Simon Krughoff [ frossie, swinbank, krughoff ] John Swinbank [ swinbank ]
            Hide
            jsick Jonathan Sick added a comment -

            John Swinbank, could you help me find a suitable technical reviewer?

            Also, Jim Bosch, although you don't have to give a full review, I'd be interested in your take on whether this tutorial series will be useful for the workshops you're giving. I'd like to add additional parts to the tutorial series on image display and source analysis.

            Summary

            • This PR adds a new "Getting Started" section on the homepage. This section is meant to give a good onboarding experience for new and prospective users.
            • The tutorial itself is adapted from https://dmtn-023.lsst.io and currently focuses on using command line tasks to ingest data in the Butler, using processCcd.py, making coadditions, and measuring sources. The series can be expanded later to include image display and table analysis tutorials later.
            • An installation tutorial guides the user through the installation choices and makes sure the user has Git LFS set up to clone same ci_hsc data.
            • Refactored the system macOS and Linux prerequisite from the newinstall.sh page into separate to make it easier to follow the newinstall documentation. More work is needed on that documentation to separate the "how-to" from the reference aspects of the newinstall installation.

            Note: a blaring issue with the tutorial is that the installation points to the tag of the last major release, while the tutorial itself likely needs a more recent release. This can only be worked out with a proper release and CI process for the documentation. This needs to be worked out in follow-up tickets.

            New pages

            Updated pages

            Show
            jsick Jonathan Sick added a comment - John Swinbank , could you help me find a suitable technical reviewer? Also, Jim Bosch , although you don't have to give a full review, I'd be interested in your take on whether this tutorial series will be useful for the workshops you're giving. I'd like to add additional parts to the tutorial series on image display and source analysis. Summary This PR adds a new "Getting Started" section on the homepage. This section is meant to give a good onboarding experience for new and prospective users. The tutorial itself is adapted from https://dmtn-023.lsst.io and currently focuses on using command line tasks to ingest data in the Butler, using processCcd.py, making coadditions, and measuring sources. The series can be expanded later to include image display and table analysis tutorials later. An installation tutorial guides the user through the installation choices and makes sure the user has Git LFS set up to clone same ci_hsc data. Added a small Git LFS configuration document that's oriented towards end users (as opposed to the more complex document at https://developer.lsst.io/tools/git_lfs.html ). Refactored the system macOS and Linux prerequisite from the newinstall.sh page into separate to make it easier to follow the newinstall documentation. More work is needed on that documentation to separate the "how-to" from the reference aspects of the newinstall installation. Note: a blaring issue with the tutorial is that the installation points to the tag of the last major release, while the tutorial itself likely needs a more recent release. This can only be worked out with a proper release and CI process for the documentation. This needs to be worked out in follow-up tickets. New pages https://pipelines.lsst.io/v/DM-10637/getting-started/installation.html https://pipelines.lsst.io/v/DM-10637/getting-started/data-setup.html https://pipelines.lsst.io/v/DM-10637/getting-started/processccd.html https://pipelines.lsst.io/v/DM-10637/getting-started/coaddition.html https://pipelines.lsst.io/v/DM-10637/getting-started/photometry.html https://pipelines.lsst.io/v/DM-10637/install/git-lfs.html https://pipelines.lsst.io/v/DM-10637/install/prereqs/index.html (and linked pages) Updated pages https://pipelines.lsst.io/v/DM-10637 https://pipelines.lsst.io/v/DM-10637/install/newinstall.html https://pipelines.lsst.io/v/DM-10637/install/lsstsw.html
            jsick Jonathan Sick made changes -
            Reviewers John Swinbank [ swinbank ] Jim Bosch, John Swinbank [ jbosch, swinbank ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11034 [ DM-11034 ]
            Hide
            jbosch Jim Bosch added a comment -

            The workshop I was giving has already happened, and the topic for that tutorial was running slightly lower-level Tasks (essentially the leaf subtasks of ProcessCcdTask) from Python, rather than running higher-level processing from the command-line. But I pointed the attendees at DMTN-23 as something they could work through on their own to cover the latter topic, and around this time last year I did use the first draft of DMTN-23 for a workshop. I don't see any reason why your version wouldn't work at least as well for both of those purposes, once it's cleaned up and merged. I think a workshop based on it would probably work best as a session in which attendees worked though it at their own pace and got help from roving experts, which is more or less what I did last year. This year's tutorial (which had materials in Jupyter notebook form) was much more interactive in that it had some exercises for attendees to work on between more lecture-like steps. I think that worked much better for a live tutorial, but I think it'd be a lot harder to have it also serve as standalone documentation.

            Show
            jbosch Jim Bosch added a comment - The workshop I was giving has already happened, and the topic for that tutorial was running slightly lower-level Tasks (essentially the leaf subtasks of ProcessCcdTask) from Python, rather than running higher-level processing from the command-line. But I pointed the attendees at DMTN-23 as something they could work through on their own to cover the latter topic, and around this time last year I did use the first draft of DMTN-23 for a workshop. I don't see any reason why your version wouldn't work at least as well for both of those purposes, once it's cleaned up and merged. I think a workshop based on it would probably work best as a session in which attendees worked though it at their own pace and got help from roving experts, which is more or less what I did last year. This year's tutorial (which had materials in Jupyter notebook form) was much more interactive in that it had some exercises for attendees to work on between more lecture-like steps. I think that worked much better for a live tutorial, but I think it'd be a lot harder to have it also serve as standalone documentation.
            Hide
            swinbank John Swinbank added a comment -

            My suggestion would be that over the course of this week you discuss this tutorial with Lauren MacArthur and have her read over it. If she's happy, I think we can regard it as reviewed.

            Show
            swinbank John Swinbank added a comment - My suggestion would be that over the course of this week you discuss this tutorial with Lauren MacArthur and have her read over it. If she's happy, I think we can regard it as reviewed.
            swinbank John Swinbank made changes -
            Reviewers Jim Bosch, John Swinbank [ jbosch, swinbank ] Lauren MacArthur [ lauren ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11077 [ DM-11077 ]
            jsick Jonathan Sick made changes -
            Story Points 5 9.2
            Hide
            swinbank John Swinbank added a comment -

            Hey, Jonathan Sick, Lauren MacArthur

            Since there's a lot of work involved here, Frossie Economou & I suggest that we regard this ticket as done, and file a new ticket which is essentially "work through the tutorial and check that it all works", which, I gather, is what Lauren MacArthur has effectively been doing. Does that work for you both?

            Jonathan Sick, I'm not sure what your plans are for putting this live on pipelines.lsst.io — my suggestion would be that we wait until after the follow-up ticket described above.

            Show
            swinbank John Swinbank added a comment - Hey, Jonathan Sick , Lauren MacArthur — Since there's a lot of work involved here, Frossie Economou & I suggest that we regard this ticket as done, and file a new ticket which is essentially "work through the tutorial and check that it all works", which, I gather, is what Lauren MacArthur has effectively been doing. Does that work for you both? Jonathan Sick , I'm not sure what your plans are for putting this live on pipelines.lsst.io — my suggestion would be that we wait until after the follow-up ticket described above.
            Hide
            lauren Lauren MacArthur added a comment -

            That works for me

            Show
            lauren Lauren MacArthur added a comment - That works for me
            Hide
            jsick Jonathan Sick added a comment - - edited

            OK. I guess I can put this on a user branch for integration? (for what it's worth, combining business accounting with the Git branching has its downsides)

            It would certainly be better to merge this after v14 is out (the tutorial won't be compatible with the 13 or 13.1).

            DM-11077 and DM-11034 are related tickets that add additional tutorial steps. Should I treat those tickets the same way? Close for now and add them to the new review ticket?

            Show
            jsick Jonathan Sick added a comment - - edited OK. I guess I can put this on a user branch for integration? (for what it's worth, combining business accounting with the Git branching has its downsides) It would certainly be better to merge this after v14 is out (the tutorial won't be compatible with the 13 or 13.1). DM-11077 and DM-11034 are related tickets that add additional tutorial steps. Should I treat those tickets the same way? Close for now and add them to the new review ticket?
            Hide
            lauren Lauren MacArthur added a comment -

            For fear of them getting lost, I submitted some preliminary comments on the PR.

            Show
            lauren Lauren MacArthur added a comment - For fear of them getting lost, I submitted some preliminary comments on the PR.
            Hide
            jsick Jonathan Sick added a comment -
            Show
            jsick Jonathan Sick added a comment - Thanks Lauren MacArthur !
            Hide
            swinbank John Swinbank added a comment -

            Sorry for being slow on getting back to this.

            OK. I guess I can put this on a user branch for integration?

            (for what it's worth, combining business accounting with the Git branching has its downsides)

            I think that's partially true, but you yourself raise another issue here: we don't want to merge to master until after the next release.

            (Actually I'm not sure how that'll work in general — will we tag pipelines_lsst_io at the same time as everything else which makes up the release? And show the version corresponding to the most recent release, rather than master, by default?)

            DM-11077 and DM-11034 are related tickets that add additional tutorial steps. Should I treat those tickets the same way? Close for now and add them to the new review ticket?

            I think the same approach, but maybe making a separate "review" ticket for each one, rather than combining them all into one.

            Thanks for your help with this!

            Show
            swinbank John Swinbank added a comment - Sorry for being slow on getting back to this. OK. I guess I can put this on a user branch for integration? (for what it's worth, combining business accounting with the Git branching has its downsides) I think that's partially true, but you yourself raise another issue here: we don't want to merge to master until after the next release. (Actually I'm not sure how that'll work in general — will we tag pipelines_lsst_io at the same time as everything else which makes up the release? And show the version corresponding to the most recent release, rather than master , by default?) DM-11077 and DM-11034 are related tickets that add additional tutorial steps. Should I treat those tickets the same way? Close for now and add them to the new review ticket? I think the same approach, but maybe making a separate "review" ticket for each one, rather than combining them all into one. Thanks for your help with this!
            jsick Jonathan Sick made changes -
            Link This issue is triggering DM-11391 [ DM-11391 ]
            jsick Jonathan Sick made changes -
            Story Points 9.2 9.7
            Hide
            jsick Jonathan Sick added a comment -

            Closing this ticket out. I've created a new branch and PR with DM-11391 (I didn't go with an integration branch after all; instead DM-11391, DM-11392, and DM-11393 just branch off each other).

            Show
            jsick Jonathan Sick added a comment - Closing this ticket out. I've created a new branch and PR with DM-11391 (I didn't go with an integration branch after all; instead DM-11391 , DM-11392 , and DM-11393 just branch off each other).
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status In Review [ 10004 ] Done [ 10002 ]

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              Lauren MacArthur
              Watchers:
              Jim Bosch, John Swinbank, Jonathan Sick, Lauren MacArthur
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.