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

Simplify initialization of display_firefly and firefly_client

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: SUIT
    • Labels:
      None
    • Story Points:
      7
    • Sprint:
      SUIT Sprint 2018-05
    • Team:
      Science User Interface

      Description

      Improvements to firefly_client and display_firefly to allow initialization without specifying Firefly server or channel, in these two use cases:

      1. User in a Jupyterlabdemo environment which also has a Firefly server
      2. User running on own machine with dockerized Firefly server
      • Rename the first parameter for initializing FireflyClient to be url, and remove the basedir parameter by folding it into url. An example of url is https://lsst-demo.ncsa.illinois.edu/firefly.
      • When firefly_client  is imported, default url to the value of the environment variable FIREFLY_URL if it is defined. If it is not defined, default to http://localhost:8080/firefly. For the parameter html_file, default to the value of the environment variable FIREFLY_HTML if it is defined; if not defined, default to None which is equivalent to an empty string.
      • By default, do not specify channel and allow it to be auto-generated. In display_firefly, expose the channel, the browser url, and the instance of FireflyClient
      • In FireflyClient.launch_browser, check if the webbrowser open has failed, and display a message that the browser couldn't be auto-opened, directing the user to open the url in a browser window. In the Jupyter notebook, the message is a clickable link.
      • Update documentation, and in the case of firefly_client, example notebooks.
      • Reorganize display_firefly documentation for publication to pipelines.lsst.io.

        Attachments

          Issue Links

            Activity

            Hide
            shupe David Shupe added a comment -

            The online documentation can be reviewed at https://firefly-client.lsst.io/v/DM-14391-simple-init

            Show
            shupe David Shupe added a comment - The online documentation can be reviewed at  https://firefly-client.lsst.io/v/DM-14391-simple-init
            Hide
            shupe David Shupe added a comment -

            This pull request will make it easier to initialize the display_firefly backend. The code changes in display_firefly are small, since most of the effort has gone into firefly_client (already reviewed by Trey Roby).

            Documentation has been updated to reflect the new initialization. The doc files have been reorganized and moved to follow Jonathan Sick's instructions for publication on pipelines.lsst.io.

            Show
            shupe David Shupe added a comment - This pull request will make it easier to initialize the display_firefly backend. The code changes in display_firefly are small, since most of the effort has gone into firefly_client (already reviewed by Trey Roby ). Documentation has been updated to reflect the new initialization. The doc files have been reorganized and moved to follow Jonathan Sick 's instructions for publication on pipelines.lsst.io.
            Hide
            krughoff Simon Krughoff added a comment -

            See comments on the PR.

            Show
            krughoff Simon Krughoff added a comment - See comments on the PR.
            Hide
            shupe David Shupe added a comment -

            Verified that display_firefly and firefly_client work as desired in the w_2018_20 build of the Notebook Aspect.

            Show
            shupe David Shupe added a comment - Verified that display_firefly and firefly_client work as desired in the w_2018_20 build of the Notebook Aspect.

              People

              Assignee:
              shupe David Shupe
              Reporter:
              shupe David Shupe
              Reviewers:
              Simon Krughoff
              Watchers:
              Adam Thornton, David Shupe, Gregory Dubois-Felsmann, Simon Krughoff, Trey Roby, Xiuqin Wu [X] (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.