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

obs_decam README is confusing

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: obs_decam
    • Labels:
      None
    • Story Points:
      4
    • Epic Link:
    • Sprint:
      AP F20-4 (September), AP S21-3 (February), AP F21-1 (June), AP F21-2 (July)
    • Team:
      Alert Production
    • Urgent?:
      No

      Description

      The obs_decam README file gives instructions that are not really necessary (since we distribute the package along with the rest of the stack) and misleading (since a git clone of master will not likely run against a non-master stack). A user had problems trying to follow them and was also confused about whether the package contained the data referenced in the README.

      Please correct the instructions and make them more friendly to new users.

        Attachments

          Issue Links

          duplicates

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-7283 Document how to process DECam data with the stack

          • Invalid
          relates to

          Bug - A problem which impairs or prevents the functions of the product. DM-31190 ap_verify datasets assume default bias/flats for DECam

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-29340 Write guide to using Gen 3 ap pipelines

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            swinbank John Swinbank added a comment -

            Hey Meredith Rawls — would you be able to spend a few minutes cleaning up these instructions, please? Thank you very much!

            Show
            swinbank John Swinbank added a comment - Hey Meredith Rawls — would you be able to spend a few minutes cleaning up these instructions, please? Thank you very much!
            Hide
            Permalink
            swinbank John Swinbank added a comment -

            Maybe worth adding — I agree with Kian-Tat Lim that these instructions may not really be necessary. They are certainly more elaborate than we provide with other camera packages. If this material is actually useful, it would probably be better on pipelines.lsst.io than stuffed in this README.

            In short — please don't feel you have to simply update these instructions to describe the current situation, but rather feel free to significantly trim or move material that you don't feel is helpful.

            Show
            swinbank John Swinbank added a comment - Maybe worth adding — I agree with Kian-Tat Lim that these instructions may not really be necessary. They are certainly more elaborate than we provide with other camera packages. If this material is actually useful, it would probably be better on pipelines.lsst.io than stuffed in this README. In short — please don't feel you have to simply update these instructions to describe the current situation, but rather feel free to significantly trim or move material that you don't feel is helpful.
            Hide
            Permalink
            sullivan Ian Sullivan added a comment -

            This might make the most sense to complete after DM-24253 and DM-25124 while that is fresh in your mind. It could be focused on using the LSST stack for the full processing, as opposed to using the community pipeline calibration products. Since it is often used, the instructions (here or preferably with a link to them in pipelines.lsst.io) could include simple recipes for processing raw images + calibrations through processCcd.py

            Show
            sullivan Ian Sullivan added a comment - This might make the most sense to complete after DM-24253 and DM-25124 while that is fresh in your mind. It could be focused on using the LSST stack for the full processing, as opposed to using the community pipeline calibration products. Since it is often used, the instructions (here or preferably with a link to them in pipelines.lsst.io) could include simple recipes for processing raw images + calibrations through processCcd.py
            Hide
            Permalink
            mrawls Meredith Rawls added a comment -

            One more thing to pile on to this embarrassingly overdue ticket. I should remove all the things in obs_decam/pipelines, since I ported them to ap_pipe/pipelines as part of DM-29221.

            Show
            mrawls Meredith Rawls added a comment - One more thing to pile on to this embarrassingly overdue ticket. I should remove all the things in obs_decam/pipelines, since I ported them to ap_pipe/pipelines as part of DM-29221 .
            Hide
            Permalink
            mrawls Meredith Rawls added a comment -

            John Parejko, would you please review this ticket? I've put it off for a while (as you can see...) but it's finally less confusing!

            Show
            mrawls Meredith Rawls added a comment - John Parejko , would you please review this ticket? I've put it off for a while (as you can see...) but it's finally less confusing!
            Hide
            Permalink
            mrawls Meredith Rawls added a comment -

            Ready for your re-review. I built the docs and caught several syntax errors, and discovered doc/conf.py and friends needed updating. I ran Jenkins and it passed. https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/34604/pipeline. Amusingly, the issue I encountered with documenteer was the exact problem Zach Langford encountered 2 months ago, so thanks for encouraging him to post on Slack about it!

            Show
            mrawls Meredith Rawls added a comment - Ready for your re-review. I built the docs and caught several syntax errors, and discovered doc/conf.py and friends needed updating. I ran Jenkins and it passed. https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/34604/pipeline . Amusingly, the issue I encountered with documenteer was the exact problem Zach Langford encountered 2 months ago, so thanks for encouraging him to post on Slack about it!
            Hide
            Permalink
            Parejkoj John Parejko added a comment -

            I left a handful more comments, but this looks good. Thanks for cleaning up these docs!

            Show
            Parejkoj John Parejko added a comment - I left a handful more comments, but this looks good. Thanks for cleaning up these docs!

              People

              Assignee:
              mrawls Meredith Rawls
              Reporter:
              ktl Kian-Tat Lim
              Reviewers:
              John Parejko
              Watchers:
              Ian Sullivan, John Parejko, Kian-Tat Lim, Meredith Rawls
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.