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

Update user guide for display_firefly

    XMLWordPrintable

    Details

    • Story Points:
      6
    • Epic Link:
    • Sprint:
      SUIT Sprint 2019-01, SUIT Sprint 2019-02
    • Team:
      Science User Interface

      Description

      The daily build of pipelines.lsst.io includes a section for lsst.display.firefly, but it is only a stub. We wrote a user guide previously in DM-10601 which at that time was hosted on a temporary site. The index.rst file needs to be moved into the right subdirectory.

      As part of DM-16782, the module documentation for lsst.display.firefly was moved to the right location to appear on pipelines.lsst.io. This ticket is to expand the user guide to document the new functionality that has been added in recent months. The user guide will contain some pages that apply to the LSST Science Platform case, and some other pages that cover our other supported use case of a user running the stack and Firefly locally on their own desktop or laptop.

      If feasible, the work in this ticket will enable automodapi, as has been done for lsst.display.ds9. This likely will require updates to docstrings.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-16682 Update Python API documentation

          • In Progress

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            shupe David Shupe created issue -
            xiuqin Xiuqin Wu [X] (Inactive) made changes -
            Field Original Value New Value
            Epic Link DM-8773 [ 28612 ]
            xiuqin Xiuqin Wu [X] (Inactive) made changes -
            Sprint SUIT Sprint 2019-01 [ 814 ]
            xiuqin Xiuqin Wu [X] (Inactive) made changes -
            Labels documentation
            xiuqin Xiuqin Wu [X] (Inactive) made changes -
            Sprint SUIT Sprint 2019-01 [ 814 ] SUIT Sprint 2019-01, SUIT Sprint 2019-02 [ 814, 815 ]
            xiuqin Xiuqin Wu [X] (Inactive) made changes -
            Link This issue relates to DM-16682 [ DM-16682 ]
            shupe David Shupe made changes -
            Description The daily build of pipelines.lsst.io includes a section for {{lsst.display.firefly}}, but it is only a stub. We wrote a user guide previously in DM-10601 which at that time was hosted on a temporary site. The {{index.rst}} file needs to be moved into the right subdirectory.

            We ought to enable {{automodapi}} as well, as has been done for {{lsst.display.ds9}}. 

            In this ticket we should document the new functions we have added recently, such as overlay of LSST source detection footprints.             		-The daily build of pipelines.lsst.io includes a section for {{lsst.display.firefly}}, but it is only a stub. We wrote a user guide previously in DM-10601 which at that time was hosted on a temporary site. The {{index.rst}} file needs to be moved into the right subdirectory.-

            As part of DM-
            We ought to enable {{automodapi}} as well, as has been done for {{lsst.display.ds9}}. 

            In this ticket we should document the new functions we have added recently, such as overlay of LSST source detection footprints.
            shupe David Shupe made changes -
            Description -The daily build of pipelines.lsst.io includes a section for {{lsst.display.firefly}}, but it is only a stub. We wrote a user guide previously in DM-10601 which at that time was hosted on a temporary site. The {{index.rst}} file needs to be moved into the right subdirectory.-

            As part of DM-
            We ought to enable {{automodapi}} as well, as has been done for {{lsst.display.ds9}}. 

            In this ticket we should document the new functions we have added recently, such as overlay of LSST source detection footprints.             		-The daily build of pipelines.lsst.io includes a section for {{lsst.display.firefly}}, but it is only a stub. We wrote a user guide previously in DM-10601 which at that time was hosted on a temporary site. The {{index.rst}} file needs to be moved into the right subdirectory.-

            As part of DM-16782, the module documentation for {{lsst.display.firefly}} was moved to the right location to appear on pipelines.lsst.io. This ticket is to expand the user guide to document the new functionality that has been added in recent months. The user guide will contain some pages that apply to the LSST Science Platform case, and some other pages that cover our other supported use case of a user running the stack and Firefly locally on their own desktop or laptop.

            If feasible, the work in this ticket will enable {{automodapi}}, as has been done for {{lsst.display.ds9}}. This likely will require updates to docstrings. 

            shupe David Shupe made changes -
            Story Points 2 6
            shupe David Shupe made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            frossie Frossie Economou made changes -
            Status Admin Review [ 3 ] In Progress [ 11605 ]
            frossie Frossie Economou made changes -
            Status Review [ 11605 ] In Progress [ 3 ]
            Hide
            Permalink
            shupe David Shupe added a comment -

            I estimate the review will be short. It's a matter of looking at the html I sent.

            Show
            shupe David Shupe added a comment - I estimate the review will be short. It's a matter of looking at the html I sent.
            shupe David Shupe made changes -
            Reviewers Cindy Wang [ cwang ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            shupe David Shupe made changes -
            Description -The daily build of pipelines.lsst.io includes a section for {{lsst.display.firefly}}, but it is only a stub. We wrote a user guide previously in DM-10601 which at that time was hosted on a temporary site. The {{index.rst}} file needs to be moved into the right subdirectory.-

            As part of DM-16782, the module documentation for {{lsst.display.firefly}} was moved to the right location to appear on pipelines.lsst.io. This ticket is to expand the user guide to document the new functionality that has been added in recent months. The user guide will contain some pages that apply to the LSST Science Platform case, and some other pages that cover our other supported use case of a user running the stack and Firefly locally on their own desktop or laptop.

            If feasible, the work in this ticket will enable {{automodapi}}, as has been done for {{lsst.display.ds9}}. This likely will require updates to docstrings. 

            		-The daily build of pipelines.lsst.io includes a section for {{lsst.display.firefly}}, but it is only a stub. We wrote a user guide previously in DM-10601 which at that time was hosted on a temporary site. The {{index.rst}} file needs to be moved into the right subdirectory.-

            As part of DM-16782, the module documentation for {{lsst.display.firefly}} was moved to the right location to appear on pipelines.lsst.io. This ticket is to expand the user guide to document the new functionality that has been added in recent months. The user guide will contain some pages that apply to the LSST Science Platform case, and some other pages that cover our other supported use case of a user running the stack and Firefly locally on their own desktop or laptop.

            -If feasible, the work in this ticket will enable {{automodapi}}, as has been done for {{lsst.display.ds9}}. This likely will require updates to docstrings.-

            Hide
            Permalink
            shupe David Shupe added a comment -

            Review completed in person and on Github.

            Show
            shupe David Shupe added a comment - Review completed in person and on Github.
            shupe David Shupe made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            shupe David Shupe made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]

              People

              Assignee:
              shupe David Shupe
              Reporter:
              shupe David Shupe
              Reviewers:
              Cindy Wang [X] (Inactive)
              Watchers:
              Cindy Wang [X] (Inactive), David Shupe, Gregory Dubois-Felsmann, Jonathan Sick, Tatiana Goldina, Trey Roby, Xiuqin Wu [X] (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.