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

Add tutorial-level documentation for ctrl_pool

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Invalid
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ctrl_pool
    • Labels:
    • Story Points:
      4
    • Team:
      Data Release Production

      Description

      The new ctrl_pool package (port of hscPipeBase) has no tutorial-level documentation, making it hard to figure out how to start using the package.

      Unfortunately, I think only Paul Price is qualified to write it directly, though it may make sense to have someone unfamiliar write it while bugging Paul a lot, both to transfer the knowledge and target the documentation better.

        Attachments

          Issue Links

          duplicates

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-6596 Write command-line driver tutorial for LSST@Europe2 meeting

          • Done
          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-2983 Backport HSC parallelization code

          • Done
          mentioned in

          Page Loading...

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            price Paul Price added a comment -

            I'm happy to give a brain dump to anyone who will write the docs.

            Here are some examples using the BatchPoolTask:

            Show
            price Paul Price added a comment - I'm happy to give a brain dump to anyone who will write the docs. Here are some examples using the BatchPoolTask : ProcessExposureTask : https://github.com/HyperSuprime-Cam/hscPipe/blob/master/python/hsc/pipe/tasks/processExposure.py StackTask : https://github.com/HyperSuprime-Cam/hscPipe/blob/master/python/hsc/pipe/tasks/stack.py MultiBandTask : https://github.com/HyperSuprime-Cam/hscPipe/blob/master/python/hsc/pipe/tasks/multiband.py
            Hide
            Permalink
            swinbank John Swinbank added a comment - - edited

            There's already a demo script in ctrl_pool: first step here is to look at that and figure out if it's adequate, and make sure it's properly signposted. We should then also get sign-off from NCSA to make sure they are ready to accept responsibility for ctrl_pool.

            Show
            swinbank John Swinbank added a comment - - edited There's already a demo script in ctrl_pool : first step here is to look at that and figure out if it's adequate, and make sure it's properly signposted. We should then also get sign-off from NCSA to make sure they are ready to accept responsibility for ctrl_pool .
            Hide
            Permalink
            yusra Yusra AlSayyad added a comment -

            This was fulfilled by https://dmtn-023.lsst.io/ I think.

            Show
            yusra Yusra AlSayyad added a comment - This was fulfilled by https://dmtn-023.lsst.io/ I think.
            Hide
            Permalink
            tjenness Tim Jenness added a comment -

            Marked as a duplicate of DM-6596.

            Show
            tjenness Tim Jenness added a comment - Marked as a duplicate of DM-6596 .

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              jbosch Jim Bosch
              Watchers:
              Jim Bosch, John Swinbank, Paul Price, Tim Jenness, Yusra AlSayyad
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: