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

Document meas_extensions_ngmix

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: meas_extensions_ngmix
    • Labels:
      None
    • Story Points:
      2
    • Epic Link:
    • Sprint:
      DRP F16-2
    • Team:
      Data Release Production

      Description

      meas_extensions_ngmix has no useful documentation, not even a doc directory. Add some.

      This should include at least an overview of the package contents, a description of its capabilities, and instructions on enabling it within the meas_base framework. The package should have a README.

        Attachments

          Issue Links

            Activity

            Hide
            swinbank John Swinbank added a comment -

            Perry Gee – as discussed at the sprint meeting, can you take this on? I'm happy to help as necessary.

            The minimum we need is:

            • A README file which describes (briefly) what ngmix is and why users should care. This just needs to be a couple sentences.
            • A doc directory following the layout shown at, for example, https://github.com/lsst/meas_extensions_photometryKron/tree/master/doc. We should add a little more detail than that provides though, since ngmix is not such a well established technique as Kron photometry. I think we'd be looking for a couple of paragraphs covering exactly what this plugin is useful for and how users can enable it.
            Show
            swinbank John Swinbank added a comment - Perry Gee – as discussed at the sprint meeting, can you take this on? I'm happy to help as necessary. The minimum we need is: A README file which describes (briefly) what ngmix is and why users should care. This just needs to be a couple sentences. A doc directory following the layout shown at, for example, https://github.com/lsst/meas_extensions_photometryKron/tree/master/doc . We should add a little more detail than that provides though, since ngmix is not such a well established technique as Kron photometry. I think we'd be looking for a couple of paragraphs covering exactly what this plugin is useful for and how users can enable it.
            Hide
            pgee Perry Gee added a comment -

            Do you have time to review this one too?

            This is essentially all documentation. I am unsure how the doc is supposed to be done, and would appreciate any comments.

            Show
            pgee Perry Gee added a comment - Do you have time to review this one too? This is essentially all documentation. I am unsure how the doc is supposed to be done, and would appreciate any comments.
            Hide
            jsick Jonathan Sick added a comment -

            Sure, I’ll take a look. Don’t forget to add a README file too.

            Show
            jsick Jonathan Sick added a comment - Sure, I’ll take a look. Don’t forget to add a README file too.
            Hide
            pgee Perry Gee added a comment -

            I was unsure what format this README was suppposed to be in, but I have provided a few paragraphs in text format.

            I am not really the right person to explain why someone would want to use this package. I think that more testing would be required for me to say. But as I understand from Jim, the two plugins we've provided are really precursors for more interesting plugins we may provide later. So trying to tell people why they would use this package may be premature.

            The two review pieces are README and doc/mainpage.dox. I copied the style from meas_base/doc

            Show
            pgee Perry Gee added a comment - I was unsure what format this README was suppposed to be in, but I have provided a few paragraphs in text format. I am not really the right person to explain why someone would want to use this package. I think that more testing would be required for me to say. But as I understand from Jim, the two plugins we've provided are really precursors for more interesting plugins we may provide later. So trying to tell people why they would use this package may be premature. The two review pieces are README and doc/mainpage.dox. I copied the style from meas_base/doc
            Hide
            jsick Jonathan Sick added a comment -

            I’ve left some comments on the PR. It looks like a good start considering that the package is still young.

            Show
            jsick Jonathan Sick added a comment - I’ve left some comments on the PR. It looks like a good start considering that the package is still young.
            Hide
            pgee Perry Gee added a comment -

            All points in pull request answered.

            Show
            pgee Perry Gee added a comment - All points in pull request answered.

              People

              Assignee:
              pgee Perry Gee
              Reporter:
              swinbank John Swinbank
              Reviewers:
              Jonathan Sick
              Watchers:
              John Swinbank, Jonathan Sick, Perry Gee
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins Builds

                  No builds found.