Tickets/preops 3763

schedview/app/scheduler_dashboard/__init__.py

@@ -1 +1 @@
-from .scheduler_dashboard import sched_app
+from .scheduler_dashboard import scheduler_app

schedview/app/scheduler_dashboard/scheduler_dashboard.py

@@ -38,6 +38,7 @@
 from bokeh.models import ColorBar, LinearColorMapper
 from bokeh.models.widgets.tables import BooleanFormatter, HTMLTemplateFormatter
 from pandas import Timestamp
+from panel.io.loading import start_loading_spinner, stop_loading_spinner
 from pytz import timezone
 
 # For the conditions.mjd bugfix
@@ -51,8 +52,9 @@
 
 DEFAULT_CURRENT_TIME = Time.now()
 DEFAULT_TIMEZONE = "America/Santiago"
-COLOR_PALETTES = [color for color in bokeh.palettes.__palettes__ if "256" in color]
 LOGO = "/assets/lsst_white_logo.png"
+COLOR_PALETTES = [color for color in bokeh.palettes.__palettes__ if "256" in color]
+
 
 pn.extension(
     "tabulator",
@@ -89,7 +91,8 @@
     if dataframe_row[url_column] == "":
         return dataframe_row[name_column]
     else:
-        return f'<a href="{dataframe_row[url_column]}" target="_blank"> {dataframe_row[name_column]}</a>'
+        return f'<a href="{dataframe_row[url_column]}" target="_blank"> \
+            {dataframe_row[name_column]}</a>'
 
 
 class Scheduler(param.Parameterized):
@@ -131,6 +134,7 @@
     color_palette = param.Selector(default="Viridis256", objects=COLOR_PALETTES, doc="")
     summary_widget = param.Parameter(default=None, doc="")
     reward_widget = param.Parameter(default=None, doc="")
+    show_loading_indicator = param.Boolean(default=False)
 
     # Param parameters (used in depends decoraters and trigger calls).
     _publish_summary_widget = param.Parameter(None)
@@ -165,25 +169,24 @@
     _display_reward = False
     _display_dashboard_data = False
     _do_not_trigger_update = True
-    _show_loading_indicator = False
     _model_observatory = ModelObservatory(init_load_length=1)
 
-    # ------------------------------------------------- User actions
+    # ------------------------------------------------------------ User actions
 
     @param.depends("scheduler_fname", watch=True)
     def _update_scheduler_fname(self):
         """Update the dashboard when a user enters a new filepath/URL."""
-        self._show_loading_indicator = True
+        self.show_loading_indicator = True
         self.clear_dashboard()
 
         if not self.read_scheduler():
             self.clear_dashboard()
-            self._show_loading_indicator = False
+            self.show_loading_indicator = False
             return
 
         if not self.make_scheduler_summary_df():
             self.clear_dashboard()
-            self._show_loading_indicator = False
+            self.show_loading_indicator = False
             return
 
         self.create_summary_widget()
@@ -209,12 +212,12 @@
         self._display_reward = False
         self.param.trigger("_update_headings")
 
-        self._show_loading_indicator = False
+        self.show_loading_indicator = False
 
     @param.depends("date", watch=True)
     def _update_date(self):
         """Update the dashboard when a user chooses a new date/time."""
-        self._show_loading_indicator = True
+        self.show_loading_indicator = True
         self.clear_dashboard()
 
         self._date_time = Time(
@@ -226,7 +229,7 @@
 
         if not self.make_scheduler_summary_df():
             self.clear_dashboard()
-            self._show_loading_indicator = False
+            self.show_loading_indicator = False
             return
 
         if self.summary_widget is None:
@@ -255,14 +258,14 @@
         self._display_reward = False
         self.param.trigger("_update_headings")
 
-        self._show_loading_indicator = False
+        self.show_loading_indicator = False
 
     @param.depends("USER_tier", watch=True)
     def _update_tier(self):
         """Update the dashboard when a user chooses a new tier."""
         if not self._display_dashboard_data:
             return
-
+        print(self.USER_tier)
         self._tier = self.USER_tier
         self._survey = 0
         self._survey_name = self._scheduler_summary_df[
@@ -403,7 +406,7 @@
             self.update_sky_map_with_survey_map()
         self.param.trigger("_publish_map")
 
-    # ------------------------------------------------------ Internal workings
+    # ------------------------------------------------------- Internal workings
 
     def clear_dashboard(self):
         """Clear the dashboard for a new pickle or a new date."""
@@ -465,7 +468,8 @@
             return False
 
     def make_scheduler_summary_df(self):
-        """Update conditions, make the reward and scheduler summary dataframes.
+        """Update conditions, and make the reward
+        and scheduler summary dataframes.
 
         Returns
         -------
@@ -584,7 +588,8 @@
 
     @param.depends("_publish_summary_widget")
     def publish_summary_widget(self):
-        """Publish the summary Tabulator widget to be shown on the dashboard.
+        """Publish the summary Tabulator widget
+        to be displayed on the dashboard.
 
         Returns
         -------
@@ -636,8 +641,8 @@
                     self._conditions,
                     self._reward_df.loc[[(int(self._tier[-1]), self._survey)], :],
                 )
-                # Duplicate column and apply URL formatting
-                # to one of the columns.
+                # Duplicate column and apply
+                # URL formatting to one of the columns.
                 survey_reward_df["basis_function_href"] = survey_reward_df.loc[:, "basis_function"]
                 survey_reward_df["basis_function_href"] = survey_reward_df.apply(
                     url_formatter,
@@ -792,15 +797,7 @@
             hpix_data_source = self._sky_map_base.plot.select(name="hpix_ds")[0]
 
             # CASE 1: Selection is a reward map.
-            if self.survey_map not in [
-                "u_sky",
-                "g_sky",
-                "r_sky",
-                "i_sky",
-                "z_sky",
-                "y_sky",
-                "reward",
-            ]:
+            if self.survey_map not in ["u_sky", "g_sky", "r_sky", "i_sky", "z_sky", "y_sky", "reward"]:
                 reward_underscored = self._map_name.replace(" ", "_")
                 reward_survey_key = list(key for key in self._survey_maps if self._map_name in key)[0]
                 reward_bokeh_key = list(key for key in hpix_data_source.data if reward_underscored in key)[0]
@@ -912,8 +909,8 @@
 
             # CASE 2: Reward is scalar and finite.
             elif max_basis_reward != -np.inf:
-                # Create array populated with scalar values where
-                # the sky brightness map is not NaN.
+                # Create array populated with scalar values
+                # where sky brightness map is not NaN.
                 scalar_array = hpix_data_source.data["u_sky"].copy()
                 scalar_array[~np.isnan(hpix_data_source.data["u_sky"])] = max_basis_reward
                 hpix_data_source.data[reward_underscored] = scalar_array
@@ -995,12 +992,7 @@
             self.debug_pane.object = self._debug_string
         return self.debug_pane
 
-    @param.depends("_show_loading_indicator", watch=True)
-    def update_loading_indicator(self):
-        """Update the app to show or stop showing the loading indicator."""
-        sched_app.loading = self._show_loading_indicator
-
-    # ------------------------------------------------------- Dashboard titles
+    # ------------------------------------------------------ Dashboard titles
 
     def generate_dashboard_subtitle(self):
         """Select the dashboard subtitle string based on whether whether a
@@ -1072,7 +1064,8 @@
 
     @param.depends("_update_headings")
     def dashboard_subtitle(self):
-        """Load subtitle data and create/update a pane to display subtitle.
+        """Load subtitle data and create/update
+        a String pane to display subtitle.
 
         Returns
         -------
@@ -1093,7 +1086,8 @@
 
     @param.depends("_update_headings")
     def summary_table_heading(self):
-        """Load heading data and create/update a pane to display heading.
+        """Load heading data and create/update
+        a String pane to display heading.
 
         Returns
         -------
@@ -1153,7 +1147,7 @@
         return self.map_title_pane
 
 
-# -------------------------------------------------------------- Key functions
+# --------------------------------------------------------------- Key functions
 
 
 def generate_array_for_key(number_of_columns=4):
@@ -1322,14 +1316,7 @@
     return key
 
 
-# ----------------------------------------------------------- Create dashboard
-
-
-# Initialize the dashboard layout.
-sched_app = pn.GridSpec(
-    sizing_mode="stretch_both",
-    max_height=1000,
-).servable()
+# ------------------------------------------------------------ Create dashboard
 
 
 def scheduler_app(date=None, scheduler_pickle=None):
@@ -1348,6 +1335,12 @@
     sched_app : 'panel.layout.grid.GridSpec'
         The dashboard.
     """
+    # Initialize the dashboard layout.
+    sched_app = pn.GridSpec(
+        sizing_mode="stretch_both",
+        max_height=1000,
+    ).servable()
+
     scheduler = Scheduler()
 
     if date is not None:
@@ -1356,6 +1349,11 @@
     if scheduler_pickle is not None:
         scheduler.scheduler_fname = scheduler_pickle
 
+    # show dashboard as busy when scheduler.show_loading_spinner is True
+    @pn.depends(loading=scheduler.param.show_loading_indicator, watch=True)
+    def update_loading(loading):
+        start_loading_spinner(sched_app) if loading else stop_loading_spinner(sched_app)
+
     # Dashboard title.
     sched_app[0:8, :] = pn.Row(
         pn.Column(

tests/test_scheduler_dashboard.py

@@ -53,7 +53,6 @@
     - Unit tests are run in alphabetical order.
 
 """
-
 TEST_PICKLE = str(importlib.resources.files(schedview).joinpath("data", "sample_scheduler.pickle.xz"))
 MJD_START = survey_start_mjd()
 TEST_DATE = Time(MJD_START + 0.2, format="mjd").datetime
@@ -66,17 +65,23 @@ class TestSchedulerDashboard(unittest.TestCase):
     scheduler.scheduler_fname = TEST_PICKLE
     scheduler._date_time = Time(Timestamp(TEST_DATE, tzinfo=ZoneInfo(DEFAULT_TIMEZONE))).mjd
 
-    @unittest.skip("Skipping so it does not block implementation of CI")
+    def setUp(self) -> None:
+        bokeh.io.reset_output()
+
     def test_scheduler_app(self):
-        app = scheduler_app(date=TEST_DATE, scheduler_pickle=TEST_PICKLE)
-        app_bokeh_model = app.get_root()
-        with TemporaryDirectory() as dir:
-            out_path = Path(dir)
-            saved_html_fname = out_path.joinpath("test_page.html")
-            bokeh.plotting.output_file(filename=saved_html_fname, title="Test Page")
-            bokeh.plotting.save(app_bokeh_model)
+        sched_app = scheduler_app(date=TEST_DATE, scheduler_pickle=TEST_PICKLE)
+        sched_app_bokeh_model = sched_app.get_root()
+        with TemporaryDirectory() as scheduler_dir:
+            sched_out_path = Path(scheduler_dir)
+            sched_saved_html_fname = sched_out_path.joinpath("sched_test_page.html")
+            bokeh.plotting.output_file(filename=sched_saved_html_fname, title="Scheduler Test Page")
+            bokeh.plotting.save(sched_app_bokeh_model)
+        bokeh.io.reset_output()
 
     def test_read_scheduler(self):
+        self.scheduler = Scheduler()
+        self.scheduler.scheduler_fname = TEST_PICKLE
+        self.scheduler._date_time = Time(Timestamp(TEST_DATE, tzinfo=ZoneInfo(DEFAULT_TIMEZONE))).mjd
         self.scheduler.read_scheduler()
         self.assertIsInstance(self.scheduler._scheduler, CoreScheduler)
         self.assertIsInstance(self.scheduler._conditions, Conditions)