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

Refactor "Packages & Tasks" chapter in the S/W User Guide

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
    • Team:
      SQuaRE

      Description

      Update and refactor the "Packages & Tasks" chapter of the SWUG to give a better overview of the Stack, and to incorporate a recent presentation by K-T to the DES-LSST workshop (see attached). Also update the Package Index, which should also include links to the task-level documentation, which is now being written.

        Attachments

          Activity

          Hide
          shaw Richard Shaw [X] (Inactive) added a comment -

          The "Packages & Tasks" page has been changed to "Tour of the LSST Stack" and may be viewed at: https://confluence.lsstcorp.org/display/LSWUG/Tour+of+the+Software+Stack

          The "Package Index" page has morphed into "Package & Task Index" and may be viewed at: https://confluence.lsstcorp.org/pages/viewpage.action?pageId=9929032

          Show
          shaw Richard Shaw [X] (Inactive) added a comment - The "Packages & Tasks" page has been changed to "Tour of the LSST Stack" and may be viewed at: https://confluence.lsstcorp.org/display/LSWUG/Tour+of+the+Software+Stack The "Package Index" page has morphed into "Package & Task Index" and may be viewed at: https://confluence.lsstcorp.org/pages/viewpage.action?pageId=9929032
          Hide
          shaw Richard Shaw [X] (Inactive) added a comment -

          Updates now appear in the SWUG. The Package/Task index would benefit from hyperlinks to the Task-level documentation in Doxygen, which is a bit of a moving target.

          Show
          shaw Richard Shaw [X] (Inactive) added a comment - Updates now appear in the SWUG. The Package/Task index would benefit from hyperlinks to the Task-level documentation in Doxygen, which is a bit of a moving target.
          Hide
          shaw Richard Shaw [X] (Inactive) added a comment -

          K-T: I have happily ripped off some great material from your DES/LSST workshop presentation. The affected pages certainly could use some embellishment, but they are far enough along that feedback would be useful. I would in particular be interested in your thoughts about building links to Doxygen on the Package/Task index page.

          Show
          shaw Richard Shaw [X] (Inactive) added a comment - K-T: I have happily ripped off some great material from your DES/LSST workshop presentation. The affected pages certainly could use some embellishment, but they are far enough along that feedback would be useful. I would in particular be interested in your thoughts about building links to Doxygen on the Package/Task index page.
          Hide
          ktl Kian-Tat Lim added a comment -

          Tour of the Stack:

          • I guess 20-30 third-party eups packages plus other system packages might be considered "a large number". It sounds intimidating, though.
          • I don't think it's good to call a tract "a single large exposure"; it is often created from many exposures.
          • The ctrl_* packages handle communication and task management but not really output. In addition, we run in multiple processes on multiple cores and machines, not multiple threads. Note that the -j option to CmdLineTask allows "bare" tasks to be run in parallel on one machine.
          • Maturities:
          • "Tasks Framework" should include (only) pipe_base and pex_config.
          • obs_* should be "Camera Abstraction Layer".
          • Config and data access should be "?", not "X", I think.
          • datarel is really pipeline execution middleware of a sort.
          • qserv does not have a trailing "e".
          • pipette is not used.
          • displayQA goes with pipeQA
          • I'd say ctrl_events is at least "?", if not "check". ctrl_orca, ctrl_execute, and ctrl_platform_* are also probably "?".

          Thoughts on doxygen links:

          • Every package should have an overview document; the link should go there.
          • Linking to the latest buildbot-generated master doxy is fine.

          More on the other pages later...

          Show
          ktl Kian-Tat Lim added a comment - Tour of the Stack: I guess 20-30 third-party eups packages plus other system packages might be considered "a large number". It sounds intimidating, though. I don't think it's good to call a tract "a single large exposure"; it is often created from many exposures. The ctrl_* packages handle communication and task management but not really output. In addition, we run in multiple processes on multiple cores and machines, not multiple threads. Note that the -j option to CmdLineTask allows "bare" tasks to be run in parallel on one machine. Maturities: "Tasks Framework" should include (only) pipe_base and pex_config . obs_* should be "Camera Abstraction Layer". Config and data access should be "?", not "X", I think. datarel is really pipeline execution middleware of a sort. qserv does not have a trailing "e". pipette is not used. displayQA goes with pipeQA I'd say ctrl_events is at least "?", if not "check". ctrl_orca , ctrl_execute , and ctrl_platform_* are also probably "?". Thoughts on doxygen links: Every package should have an overview document; the link should go there. Linking to the latest buildbot-generated master doxy is fine. More on the other pages later...
          Hide
          shaw Richard Shaw [X] (Inactive) added a comment -

          Thanks, K-T. I believe I've addressed all of your concerns, so I've retired (i.e., restricted access to) the former Package & Tasks page as all that material is now included in the main Tour page.

          N.B.: The pages entitled "Data Butler," "pipe_base" and "Configuration Management are place-holders, and are not ready for review.

          Show
          shaw Richard Shaw [X] (Inactive) added a comment - Thanks, K-T. I believe I've addressed all of your concerns, so I've retired (i.e., restricted access to) the former Package & Tasks page as all that material is now included in the main Tour page. N.B.: The pages entitled "Data Butler," "pipe_base" and "Configuration Management are place-holders, and are not ready for review.

            People

            • Assignee:
              shaw Richard Shaw [X] (Inactive)
              Reporter:
              shaw Richard Shaw [X] (Inactive)
              Reviewers:
              Kian-Tat Lim
              Watchers:
              Kian-Tat Lim, Mario Juric, Richard Shaw [X] (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel